com.communote.plugin.ldap.helper

Class MemberAndNonMemberModeVisitingRetriever

java.lang.Object

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

com.communote.plugin.ldap.helper.MemberAndNonMemberModeVisitingRetriever

public class MemberAndNonMemberModeVisitingRetriever
extends VisitingRetriever<ExternalGroupVO>

This retriever is able to visit members of the given filter. The members can be retrieved via member mode (memberOf) or non member mode (members).

Author:

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

Field Summary

Fields inherited from class com.communote.plugin.ldap.helper.VisitingRetriever

USN_ATTRIBUTE_KEY

Constructor Summary

Constructors

Constructor and Description
MemberAndNonMemberModeVisitingRetriever(String filter, LdapConfiguration ldapConfiguration, int timeout, int pagingSize, long internalHighestCommittedUSN, boolean isPagingAllowed, LdapGroupAttributesMapper ldapGroupAttributesMapper) Constructor.

Method Summary

Modifier and Type	Method and Description
void	accept(ExternalEntityVisitor<ExternalGroupVO> visitor, boolean incremental) This method retrieves all elements and let a visitor visit each of them.
protected org.springframework.ldap.core.ContextMapper	getContextMapper() Method to return a context mapper for mapping ldap results to the concrete result.
protected List<LdapSearchBaseDefinition>	getSearchBaseDefinitions() Method to get the search base definitions.
protected String	getSearchFilter() Method to get the search filter for entities within the repository
void	setFilter(String filter) Method to set the filter to use.

Methods inherited from class com.communote.plugin.ldap.helper.VisitingRetriever

getCollectingNameClassPairCallbackHandler, getSearchControl

Methods inherited from class java.lang.Object

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

Constructor Detail

MemberAndNonMemberModeVisitingRetriever

public MemberAndNonMemberModeVisitingRetriever(String filter,
                                               LdapConfiguration ldapConfiguration,
                                               int timeout,
                                               int pagingSize,
                                               long internalHighestCommittedUSN,
                                               boolean isPagingAllowed,
                                               LdapGroupAttributesMapper ldapGroupAttributesMapper)
                                        throws NamingException

Constructor.

Parameters:

filter - The filter to search for.

ldapConfiguration - The ldap configuration to use.

internalHighestCommittedUSN - The usn to use.

pagingSize - The maximal size of requestet pages.

timeout - The timeout for connections.

isPagingAllowed - True, if paging is allowed.

ldapGroupAttributesMapper - Mapper for group attributes.

Throws:

NamingException - Exception

Method Detail

accept

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

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

Overrides:

accept in class VisitingRetriever<ExternalGroupVO>

Parameters:

incremental - Incremental mode is currently not supported in non member mode.

visitor - The visitor.

Throws:

RetrieverException - Exception.

getContextMapper

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

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

Specified by:

getContextMapper in class VisitingRetriever<ExternalGroupVO>

Returns:

The mapper.

getSearchBaseDefinitions

protected List<LdapSearchBaseDefinition> getSearchBaseDefinitions()

Method to get the search base definitions.

Specified by:

getSearchBaseDefinitions in class VisitingRetriever<ExternalGroupVO>

Returns:

List of definitions.

getSearchFilter

protected String getSearchFilter()

Method to get the search filter for entities within the repository

Specified by:

getSearchFilter in class VisitingRetriever<ExternalGroupVO>

Returns:

The search filter as String.

setFilter

public void setFilter(String filter)

Method to set the filter to use. This allows better reuse of the retriever.

Parameters:

filter - The filter to set.