Package org.ldaptive.referral

Class FollowSearchResultReferenceHandler

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.transport.MessageFunctional<Q,S>

org.ldaptive.transport.MessageFunctional.Function<Q,S,S,S>

org.ldaptive.referral.AbstractFollowReferralHandler<SearchRequest,SearchResponse>

org.ldaptive.referral.AbstractFollowSearchReferralHandler

org.ldaptive.referral.FollowSearchResultReferenceHandler

All Implemented Interfaces:

Function<SearchResponse,SearchResponse>, Freezable, SearchResultHandler

public class FollowSearchResultReferenceHandler
extends AbstractFollowSearchReferralHandler
implements SearchResultHandler

Provides handling of an ldap continuation reference for search operations.

Nested Class Summary

Nested classes/interfaces inherited from class org.ldaptive.transport.MessageFunctional

MessageFunctional.BiConsumer<Q extends Request,S extends Result,T,U>, MessageFunctional.Consumer<Q extends Request,S extends Result,T>, MessageFunctional.Function<Q extends Request,S extends Result,T,R>

Field Summary

Fields inherited from class org.ldaptive.referral.AbstractFollowReferralHandler

DEFAULT_REFERRAL_LIMIT, logger, referralDepth, referralLimit

Constructor Summary

Constructors

Constructor	Description
FollowSearchResultReferenceHandler()	Creates a new search result reference handler.
FollowSearchResultReferenceHandler(int limit)	Creates a new search result reference handler.
FollowSearchResultReferenceHandler(int limit, int depth, ReferralConnectionFactory factory, boolean tf)	Creates a new search result reference handler.
FollowSearchResultReferenceHandler(int limit, ReferralConnectionFactory factory)	Creates a new search result reference handler.
FollowSearchResultReferenceHandler(int limit, ReferralConnectionFactory factory, boolean tf)	Creates a new search result reference handler.
FollowSearchResultReferenceHandler(ReferralConnectionFactory factory)	Creates a new search result reference handler.
FollowSearchResultReferenceHandler(ReferralConnectionFactory factory, boolean tf)	Creates a new search result reference handler.

Method Summary

Modifier and Type	Method	Description
SearchResponse	apply(SearchResponse result)
protected SearchResultHandler[]	createNextSearchResultHandler()	Creates the next search result handler for chasing referrals, which increments the referral depth.
FollowSearchResultReferenceHandler	newInstance()	Create a new instance of this message functional.

Methods inherited from class org.ldaptive.referral.AbstractFollowSearchReferralHandler

createReferralOperation, createReferralRequest

Methods inherited from class org.ldaptive.referral.AbstractFollowReferralHandler

followReferral, getReferralConnectionFactory, getReferralDepth, getReferralLimit, getSuccessResultCodes, getThrowOnFailure

Methods inherited from class org.ldaptive.transport.MessageFunctional

getConnection, getHandle, getRequest, setConnection, setHandle, setRequest

Methods inherited from class org.ldaptive.AbstractFreezable

assertMutable, freeze, freeze, freeze, isFrozen

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler()

Creates a new search result reference handler.

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(ReferralConnectionFactory factory)

Creates a new search result reference handler.

Parameters:

factory - referral connection factory

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(ReferralConnectionFactory factory,
                                          boolean tf)

Creates a new search result reference handler.

Parameters:

factory - referral connection factory

tf - whether to throw on failure to chase references

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(int limit)

Creates a new search result reference handler.

Parameters:

limit - number of references to follow

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(int limit,
                                          ReferralConnectionFactory factory)

Creates a new search result reference handler.

Parameters:

limit - number of references to follow

factory - referral connection factory

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(int limit,
                                          ReferralConnectionFactory factory,
                                          boolean tf)

Creates a new search result reference handler.

Parameters:

limit - number of references to follow

factory - referral connection factory

tf - whether to throw on failure to chase references

FollowSearchResultReferenceHandler

FollowSearchResultReferenceHandler(int limit,
                                   int depth,
                                   ReferralConnectionFactory factory,
                                   boolean tf)

Creates a new search result reference handler.

Parameters:

limit - number of references to follow

depth - number of references followed

factory - referral connection factory

tf - whether to throw on failure to chase references

Method Detail

createNextSearchResultHandler

protected SearchResultHandler[] createNextSearchResultHandler()

Description copied from class: AbstractFollowSearchReferralHandler

Creates the next search result handler for chasing referrals, which increments the referral depth.

Specified by:

createNextSearchResultHandler in class AbstractFollowSearchReferralHandler

Returns:

search result handler

apply

public SearchResponse apply(SearchResponse result)

Specified by:

apply in interface Function<SearchResponse,SearchResponse>

Overrides:

apply in class AbstractFollowReferralHandler<SearchRequest,SearchResponse>

newInstance

public FollowSearchResultReferenceHandler newInstance()

Description copied from class: MessageFunctional

Create a new instance of this message functional.

Specified by:

newInstance in class MessageFunctional<SearchRequest,SearchResponse>

Returns:

new instance of this message functional