org.ldaptive.provider.jndi

Class JndiConnection.JndiSearchIterator

java.lang.Object

org.ldaptive.provider.jndi.JndiConnection.JndiSearchIterator

All Implemented Interfaces:

SearchIterator

Enclosing class:

JndiConnection

protected class JndiConnection.JndiSearchIterator
extends java.lang.Object
implements SearchIterator

Search iterator for JNDI naming enumeration.

Field Summary

Fields

Modifier and Type	Field and Description
private SearchRequest	request Search request.
private Response<java.lang.Void>	response Response data.
private ResultCode	responseResultCode Response result code.
private javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>	results Results read from the search operation.
private javax.naming.ldap.LdapContext	searchContext Ldap context to search with.
private java.util.List<java.lang.String>	searchReferences Search reference URLs.

Constructor Summary

Constructors

Constructor and Description
JndiSearchIterator(SearchRequest sr) Creates a new jndi search iterator.

Method Summary

Modifier and Type	Method and Description
void	close() Close any resources associated with this iterator.
protected java.lang.String	formatDn(javax.naming.directory.SearchResult sr, java.lang.String baseDn) Returns a fully-qualified DN for the supplied search result.
Response<java.lang.Void>	getResponse() Returns the response data associated with this search or null if this iterator has more ldap entries to return.
protected javax.naming.directory.SearchControls	getSearchControls(SearchRequest sr) Returns a search controls object configured with the supplied search request.
protected java.lang.String	getSearchDn(javax.naming.ldap.LdapContext ctx, SearchRequest sr) Determines the DN of the supplied search request.
protected int	getSearchScope(SearchScope ss) Returns the jndi integer constant for the supplied search scope.
boolean	hasNext() Returns true if the iteration has more elements.
protected ResultCode	ignoreSearchException(ResultCode[] ignoreResultCodes, javax.naming.NamingException e) Determines whether the supplied naming exception should be ignored.
void	initialize() Initializes this jndi search iterator.
protected void	initializeSearchContext(javax.naming.ldap.LdapContext ctx, SearchRequest sr) Adds any additional environment properties found in the supplied request to the supplied context.
SearchItem	next() Returns the next element in the iteration.
protected java.lang.String	readCompositeName(java.lang.String s) Uses a composite name to parse the supplied string.
protected java.lang.String[]	readReferralUrls(javax.naming.ldap.LdapReferralException refEx) Reads all referral URLs associated with this exception by invoking the search operation on the referral context until all referrals have been read.
protected javax.naming.NamingEnumeration<javax.naming.directory.SearchResult>	search(javax.naming.ldap.LdapContext ctx, SearchRequest sr) Executes DirContext.search( javax.naming.Name, String, Object[], SearchControls).

Methods inherited from class java.lang.Object

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

Field Detail

request

private final SearchRequest request

Search request.

response

private Response<java.lang.Void> response

Response data.

responseResultCode

private ResultCode responseResultCode

Response result code.

searchReferences

private java.util.List<java.lang.String> searchReferences

Search reference URLs.

searchContext

private javax.naming.ldap.LdapContext searchContext

Ldap context to search with.

results

private javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> results

Results read from the search operation.

Constructor Detail

JndiSearchIterator

public JndiSearchIterator(SearchRequest sr)

Creates a new jndi search iterator.

Parameters:

sr - search request

Method Detail

initialize

public void initialize()
                throws LdapException

Initializes this jndi search iterator.

Throws:

LdapException - if an error occurs

initializeSearchContext

protected void initializeSearchContext(javax.naming.ldap.LdapContext ctx,
                                       SearchRequest sr)
                                throws javax.naming.NamingException

Adds any additional environment properties found in the supplied request to the supplied context.

Parameters:

ctx - to initialize for searching

sr - to read properties from

Throws:

javax.naming.NamingException - if a property cannot be added to the context

search

protected javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> search(javax.naming.ldap.LdapContext ctx,
                                                                                     SearchRequest sr)
                                                                              throws javax.naming.NamingException

Executes DirContext.search( javax.naming.Name, String, Object[], SearchControls).

Parameters:

ctx - to search

sr - to read properties from

Returns:

naming enumeration of search results

Throws:

javax.naming.NamingException - if an error occurs

getSearchControls

protected javax.naming.directory.SearchControls getSearchControls(SearchRequest sr)

Returns a search controls object configured with the supplied search request.

Parameters:

sr - search request containing configuration to create search controls

Returns:

search controls

getSearchScope

protected int getSearchScope(SearchScope ss)

Returns the jndi integer constant for the supplied search scope.

Parameters:

ss - search scope

Returns:

integer constant

hasNext

public boolean hasNext()
                throws LdapException

Description copied from interface: SearchIterator

Returns true if the iteration has more elements.

Specified by:

hasNext in interface SearchIterator

Returns:

true if the iterator has more elements

Throws:

LdapException - if an error occurs

next

public SearchItem next()
                throws LdapException

Description copied from interface: SearchIterator

Returns the next element in the iteration.

Specified by:

next in interface SearchIterator

Returns:

the next element in the iteration

Throws:

LdapException - if an error occurs

ignoreSearchException

protected ResultCode ignoreSearchException(ResultCode[] ignoreResultCodes,
                                           javax.naming.NamingException e)

Determines whether the supplied naming exception should be ignored.

Parameters:

ignoreResultCodes - to match against the exception

e - naming exception to match

Returns:

result code that should be ignored or null

readReferralUrls

protected java.lang.String[] readReferralUrls(javax.naming.ldap.LdapReferralException refEx)

Reads all referral URLs associated with this exception by invoking the search operation on the referral context until all referrals have been read. JNDI does not distinguish the URLs contained in specific references. So each URL must be treated as a separate search reference.

Parameters:

refEx - to read URLs from

Returns:

referral urls

getResponse

public Response<java.lang.Void> getResponse()

Description copied from interface: SearchIterator

Returns the response data associated with this search or null if this iterator has more ldap entries to return.

Specified by:

getResponse in interface SearchIterator

Returns:

response data

getSearchDn

protected java.lang.String getSearchDn(javax.naming.ldap.LdapContext ctx,
                                       SearchRequest sr)
                                throws javax.naming.NamingException

Determines the DN of the supplied search request. Returns Context.getNameInNamespace() if it is available, otherwise returns SearchRequest.getBaseDn().

Parameters:

ctx - ldap context the search was performed on

sr - search request

Returns:

DN

Throws:

javax.naming.NamingException - if an error occurs

formatDn

protected java.lang.String formatDn(javax.naming.directory.SearchResult sr,
                                    java.lang.String baseDn)
                             throws javax.naming.NamingException

Returns a fully-qualified DN for the supplied search result. If search result is relative, the DN is created with NameClassPair.getNameInNamespace(). Otherwise the behavior is controlled by JndiProviderConfig.getRemoveDnUrls().

Parameters:

sr - to determine DN for

baseDn - that search was performed on

Returns:

fully qualified DN

Throws:

javax.naming.NamingException - if search result name cannot be formatted as a DN

readCompositeName

protected java.lang.String readCompositeName(java.lang.String s)
                                      throws javax.naming.InvalidNameException

Uses a composite name to parse the supplied string.

Parameters:

s - composite name to read

Returns:

ldap name

Throws:

javax.naming.InvalidNameException - if the supplied string is not a valid composite name

close

public void close()
           throws LdapException

Description copied from interface: SearchIterator

Close any resources associated with this iterator.

Specified by:

close in interface SearchIterator

Throws:

LdapException - if an error occurs