org.ldaptive.io

Class Dsmlv1Reader

java.lang.Object

org.ldaptive.io.Dsmlv1Reader

All Implemented Interfaces:

SearchResultReader

public class Dsmlv1Reader
extends java.lang.Object
implements SearchResultReader

Reads DSML version 1 from a Reader and returns a SearchResult.

Field Summary

Fields

Modifier and Type	Field and Description
private static javax.xml.parsers.DocumentBuilderFactory	DOC_BUILDER_FACTORY Document builder factory.
private java.io.Reader	dsmlReader Reader to read from.
private SortBehavior	sortBehavior Sort behavior.

Constructor Summary

Constructors

Constructor and Description
Dsmlv1Reader(java.io.Reader reader) Creates a new dsml reader.
Dsmlv1Reader(java.io.Reader reader, SortBehavior sb) Creates a new dsml reader.

Method Summary

Modifier and Type	Method and Description
protected LdapAttribute	createLdapAttribute(java.lang.String name, org.w3c.dom.NodeList nodes) Returns an ldap attribute derived from the supplied node list.
protected LdapEntry	createLdapEntry(org.w3c.dom.Element entryElement) Converts the supplied DSML entry element into an ldap entry object.
protected SearchResult	createSearchResult(org.w3c.dom.Document doc) Creates a search result that corresponds to the supplied DSML document.
protected java.lang.Object	getAttrValue(org.w3c.dom.Element valueElement, boolean base64) Returns the value of the supplied element taking into account whether the value needs to be base64 decoded.
SearchResult	read() Reads DSML data from the reader and returns a search result.

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.

dsmlReader

private final java.io.Reader dsmlReader

Reader to read from.

sortBehavior

private final SortBehavior sortBehavior

Sort behavior.

Constructor Detail

Dsmlv1Reader

public Dsmlv1Reader(java.io.Reader reader)

Creates a new dsml reader.

Parameters:

reader - to read DSML from

Dsmlv1Reader

public Dsmlv1Reader(java.io.Reader reader,
                    SortBehavior sb)

Creates a new dsml reader.

Parameters:

reader - to read DSML from

sb - sort behavior of the ldap result

Method Detail

read

public SearchResult read()
                  throws java.io.IOException

Reads DSML data from the reader and returns a search result.

Specified by:

read in interface SearchResultReader

Returns:

search result derived from the DSML

Throws:

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

createSearchResult

protected SearchResult createSearchResult(org.w3c.dom.Document doc)

Creates a search result that corresponds to the supplied DSML document.

Parameters:

doc - DSML to parse

Returns:

search result

createLdapEntry

protected LdapEntry createLdapEntry(org.w3c.dom.Element entryElement)

Converts the supplied DSML entry element into an ldap entry object.

Parameters:

entryElement - to parse

Returns:

ldap entry

createLdapAttribute

protected LdapAttribute createLdapAttribute(java.lang.String name,
                                            org.w3c.dom.NodeList nodes)

Returns an ldap attribute derived from the supplied node list.

Parameters:

name - of the ldap attribute

nodes - to parse

Returns:

ldap attribute

getAttrValue

protected java.lang.Object getAttrValue(org.w3c.dom.Element valueElement,
                                        boolean base64)

Returns the value of the supplied element taking into account whether the value needs to be base64 decoded.

Parameters:

valueElement - to read value from

base64 - whether to base64 decode the value

Returns:

String or byte[] depending on the base64 flag