org.ldaptive.io

Class Dsmlv1Writer

java.lang.Object

org.ldaptive.io.Dsmlv1Writer

All Implemented Interfaces:

SearchResultWriter

public class Dsmlv1Writer
extends java.lang.Object
implements SearchResultWriter

Writes a SearchResult as DSML version 1 to a Writer.

Field Summary

Fields

Modifier and Type	Field and Description
private static javax.xml.parsers.DocumentBuilderFactory	DOC_BUILDER_FACTORY Document builder factory.
private java.io.Writer	dsmlWriter Writer to write to.
private java.util.Map<java.lang.String,java.lang.String>	outputProperties Transformer output properties.
private static javax.xml.transform.TransformerFactory	TRANSFORMER_FACTORY Transformer factory.

Constructor Summary

Constructors

Constructor and Description
Dsmlv1Writer(java.io.Writer writer) Creates a new dsml writer.

Method Summary

Modifier and Type	Method and Description
protected org.w3c.dom.Element	createAttrElement(org.w3c.dom.Document doc, LdapAttribute attr) Returns a element for the supplied ldap attribute.
protected org.w3c.dom.Document	createDsml(SearchResult result) Creates DSML that corresponds to the supplied search result.
protected java.util.List<org.w3c.dom.Element>	createDsmlAttributes(org.w3c.dom.Document doc, java.util.Collection<LdapAttribute> attrs) Returns a list of elements for the supplied attributes.
protected org.w3c.dom.Element	createObjectclassElement(org.w3c.dom.Document doc, LdapAttribute attr) Returns a element for the supplied ldap attribute.
java.util.Map<java.lang.String,java.lang.String>	getOutputProperties() Returns the transformer output properties used by this writer.
protected void	setAttrValue(org.w3c.dom.Document doc, org.w3c.dom.Element valueElement, java.lang.String value, boolean isBase64) Adds the supplied string to the value element.
void	setOutputProperties(java.util.Map<java.lang.String,java.lang.String> properties) Sets the transformer output properties used by this writer.
void	write(SearchResult result) Writes the supplied search result to the writer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOC_BUILDER_FACTORY

private static final javax.xml.parsers.DocumentBuilderFactory DOC_BUILDER_FACTORY

Document builder factory.

TRANSFORMER_FACTORY

private static final javax.xml.transform.TransformerFactory TRANSFORMER_FACTORY

Transformer factory.

dsmlWriter

private final java.io.Writer dsmlWriter

Writer to write to.

outputProperties

private java.util.Map<java.lang.String,java.lang.String> outputProperties

Transformer output properties. See Transformer.setOutputProperty(String, String).

Constructor Detail

Dsmlv1Writer

public Dsmlv1Writer(java.io.Writer writer)

Creates a new dsml writer. The following transformer output properties are set by default:

• "doctype-public", "yes"
• "indent", "yes"
• "{http://xml.apache.org/xslt}indent-amount", "2"

Parameters:

writer - to write DSML to

Method Detail

getOutputProperties

public java.util.Map<java.lang.String,java.lang.String> getOutputProperties()

Returns the transformer output properties used by this writer.

Returns:

transformer output properties

setOutputProperties

public void setOutputProperties(java.util.Map<java.lang.String,java.lang.String> properties)

Sets the transformer output properties used by this writer.

Parameters:

properties - transformer output properties

write

public void write(SearchResult result)
           throws java.io.IOException

Writes the supplied search result to the writer.

Specified by:

write in interface SearchResultWriter

Parameters:

result - search result to write

Throws:

java.io.IOException - if an error occurs using the writer

createDsml

protected org.w3c.dom.Document createDsml(SearchResult result)
                                   throws javax.xml.parsers.ParserConfigurationException

Creates DSML that corresponds to the supplied search result.

Parameters:

result - search result to parse

Returns:

DSML

Throws:

javax.xml.parsers.ParserConfigurationException - if a document builder cannot be created

createDsmlAttributes

protected java.util.List<org.w3c.dom.Element> createDsmlAttributes(org.w3c.dom.Document doc,
                                                                   java.util.Collection<LdapAttribute> attrs)

Returns a list of elements for the supplied attributes.

Parameters:

doc - to source elements from

attrs - to iterate over

Returns:

list of elements contains attributes

createAttrElement

protected org.w3c.dom.Element createAttrElement(org.w3c.dom.Document doc,
                                                LdapAttribute attr)

Returns a element for the supplied ldap attribute.

Parameters:

doc - to source elements from

attr - ldap attribute to add

Returns:

element containing the attribute

createObjectclassElement

protected org.w3c.dom.Element createObjectclassElement(org.w3c.dom.Document doc,
                                                       LdapAttribute attr)

Returns a element for the supplied ldap attribute.

Parameters:

doc - to source elements from

attr - ldap attribute to add

Returns:

element containing the attribute values

setAttrValue

protected void setAttrValue(org.w3c.dom.Document doc,
                            org.w3c.dom.Element valueElement,
                            java.lang.String value,
                            boolean isBase64)

Adds the supplied string to the value element.

Parameters:

doc - to create nodes with

valueElement - to append value to

value - to create node for

isBase64 - whether the value is base64 encoded