edu.vt.middleware.ldap.dsml

Class Dsmlv1

java.lang.Object

edu.vt.middleware.ldap.dsml.AbstractDsml

edu.vt.middleware.ldap.dsml.Dsmlv1

All Implemented Interfaces:

Serializable

public final class Dsmlv1
extends AbstractDsml

Dsmlv1 contains functions for converting LDAP search result sets into DSML version 1.

Version:

$Revision: 1330 $ $Date: 2010-05-24 00:10:53 +0200 (Mon, 24 May 2010) $

Author:

Middleware Services

See Also:

Serialized Form

Field Summary

Fields inherited from class edu.vt.middleware.ldap.dsml.AbstractDsml

beanFactory, logger

Constructor Summary

Constructors

Constructor and Description
Dsmlv1() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
org.dom4j.Document	createDsml(Iterator<SearchResult> results) This will take the results of a prior LDAP query and convert it to a DSML Document.
org.dom4j.Document	createDsml(LdapResult result) This will take the results of a prior LDAP query and convert it to a DSML Document.
protected List<org.dom4j.Element>	createDsmlAttributes(LdapAttributes ldapAttributes, org.dom4j.Namespace ns) This will return a list of DSML attribute elements from the supplied LdapAttributes.
protected LdapEntry	createLdapEntry(org.dom4j.Element entryElement) This will take a DSML Element containing an entry of type and convert it to an LDAP entry.
LdapResult	createLdapResult(org.dom4j.Document doc) This will take a DSML Document and convert it to an LdapResult.
Iterator<SearchResult>	createSearchResults(org.dom4j.Document doc) This will take a DSML Document and convert it to an Iterator of LDAP search results.

Methods inherited from class edu.vt.middleware.ldap.dsml.AbstractDsml

createDsmlAttribute, createDsmlEntry, getLdapBeanFactory, importDsml, importDsmlToLdapResult, outputDsml, outputDsml, setLdapBeanFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

Dsmlv1

public Dsmlv1()

Default constructor.

Method Detail

createDsml

public org.dom4j.Document createDsml(Iterator<SearchResult> results)

This will take the results of a prior LDAP query and convert it to a DSML Document.

Specified by:

createDsml in class AbstractDsml

Parameters:

results - Iterator of LDAP search results

Returns:

Document

createDsml

public org.dom4j.Document createDsml(LdapResult result)

This will take the results of a prior LDAP query and convert it to a DSML Document.

Specified by:

createDsml in class AbstractDsml

Parameters:

result - LdapResult

Returns:

Document

createDsmlAttributes

protected List<org.dom4j.Element> createDsmlAttributes(LdapAttributes ldapAttributes,
                                           org.dom4j.Namespace ns)

This will return a list of DSML attribute elements from the supplied LdapAttributes.

Overrides:

createDsmlAttributes in class AbstractDsml

Parameters:

ldapAttributes - LdapAttributes

ns - Namespace of DSML

Returns:

List of elements

createSearchResults

public Iterator<SearchResult> createSearchResults(org.dom4j.Document doc)

This will take a DSML Document and convert it to an Iterator of LDAP search results.

Parameters:

doc - Document of DSML

Returns:

Iterator - of LDAP search results

createLdapResult

public LdapResult createLdapResult(org.dom4j.Document doc)

This will take a DSML Document and convert it to an LdapResult.

Specified by:

createLdapResult in class AbstractDsml

Parameters:

doc - Document of DSML

Returns:

LdapResult

createLdapEntry

protected LdapEntry createLdapEntry(org.dom4j.Element entryElement)

This will take a DSML Element containing an entry of type and convert it to an LDAP entry.

Overrides:

createLdapEntry in class AbstractDsml

Parameters:

entryElement - Element of DSML content

Returns:

LdapEntry