com.communote.plugin.ldap.helper

Class VisitingRetriever<T>

java.lang.Object

com.communote.plugin.ldap.helper.VisitingRetriever<T>

Type Parameters:

T - The type of the results.

Direct Known Subclasses:

MemberAndNonMemberModeVisitingRetriever, Retriever

public abstract class VisitingRetriever<T>
extends Object

Abstract class for retrieving entities from LDAP/AD with common functionality through the visitor pattern.

Author:

Communote GmbH - http://www.communote.com/

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	USN_ATTRIBUTE_KEY USN attribute name.

Constructor Summary

Constructors

Constructor and Description
VisitingRetriever(LdapConfiguration ldapConfiguration, int timeout, int pagingSize, long internalHighestCommittedUSN, boolean isPagingAllowed, String[] binaryAttributes) Constructor to set LDAP connection from configuration.
VisitingRetriever(org.springframework.ldap.core.LdapTemplate ldapTemplate, int timeout, int pagingSize, long internalHighestCommittedUSN, boolean isPagingAllowed) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ExternalEntityVisitor<T> visitor, boolean incremental) This method retrieves all elements and let a visitor visit each of them.
protected org.springframework.ldap.core.CollectingNameClassPairCallbackHandler	getCollectingNameClassPairCallbackHandler() Method to create a handler for converting a list of results as a callback.
protected abstract org.springframework.ldap.core.ContextMapper	getContextMapper() Method to return a context mapper for mapping ldap results to the concrete result.
protected abstract List<LdapSearchBaseDefinition>	getSearchBaseDefinitions() Method to get the search base definitions.
protected SearchControls	getSearchControl(boolean searchInSubtree) SearchControl set the searchInSubtree flag, ReturningObj and timeout.
protected abstract String	getSearchFilter() Method to get the search filter for entities within the repository

Methods inherited from class java.lang.Object

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

Field Detail

USN_ATTRIBUTE_KEY

protected static final String USN_ATTRIBUTE_KEY

USN attribute name. The value can be set with a system property "com.communote.ldap.attribute-name-usnchanged". Default is "uSNChanged"

Constructor Detail

VisitingRetriever

public VisitingRetriever(LdapConfiguration ldapConfiguration,
                         int timeout,
                         int pagingSize,
                         long internalHighestCommittedUSN,
                         boolean isPagingAllowed,
                         String[] binaryAttributes)
                  throws NamingException

Constructor to set LDAP connection from configuration.

Parameters:

ldapConfiguration - Ldap configuration.

internalHighestCommittedUSN - The usn to use.

pagingSize - The maximal size of requestet pages.

timeout - The timeout for connections.

isPagingAllowed - True, if paging is allowed.

binaryAttributes - Array of binary attributes.

Throws:

NamingException - Exception.

VisitingRetriever

public VisitingRetriever(org.springframework.ldap.core.LdapTemplate ldapTemplate,
                         int timeout,
                         int pagingSize,
                         long internalHighestCommittedUSN,
                         boolean isPagingAllowed)

Constructor.

Parameters:

ldapTemplate - The template for LDAP.

internalHighestCommittedUSN - The usn to use.

pagingSize - The maximal size of requestet pages.

timeout - The timeout for connections.

isPagingAllowed - True, if paging is allowed.

Method Detail

accept

public void accept(ExternalEntityVisitor<T> visitor,
                   boolean incremental)
            throws RetrieverException

This method retrieves all elements and let a visitor visit each of them.

Parameters:

visitor - The visitor.

incremental - If true, the only incremental changes will be considered, else all.

Throws:

RetrieverException - Exception.

getCollectingNameClassPairCallbackHandler

protected org.springframework.ldap.core.CollectingNameClassPairCallbackHandler getCollectingNameClassPairCallbackHandler()

Method to create a handler for converting a list of results as a callback.

Returns:

A handler for converting the results.

getContextMapper

protected abstract org.springframework.ldap.core.ContextMapper getContextMapper()

Method to return a context mapper for mapping ldap results to the concrete result.

Returns:

The mapper.

getSearchBaseDefinitions

protected abstract List<LdapSearchBaseDefinition> getSearchBaseDefinitions()

Method to get the search base definitions.

Returns:

List of definitions.

getSearchControl

protected SearchControls getSearchControl(boolean searchInSubtree)

SearchControl set the searchInSubtree flag, ReturningObj and timeout.

Parameters:

searchInSubtree - True, if subtree search is enabled.

Returns:

SearchControls Object.

getSearchFilter

protected abstract String getSearchFilter()

Method to get the search filter for entities within the repository

Returns:

The search filter as String.