Package org.ldaptive.referral

Class FollowSearchReferralHandler

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.FollowSearchReferralHandler

All Implemented Interfaces:

Function<SearchResponse,SearchResponse>, Freezable, ReferralResultHandler<SearchResponse>, SearchResultHandler

public class FollowSearchReferralHandler
extends AbstractFollowSearchReferralHandler
implements SearchResultHandler, ReferralResultHandler<SearchResponse>

Provides handling of an ldap referral 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
FollowSearchReferralHandler()	Creates a new search referral handler.
FollowSearchReferralHandler(int limit)	Creates a new search referral handler.
FollowSearchReferralHandler(int limit, int depth, ReferralConnectionFactory factory, boolean tf)	Creates a new search referral handler.
FollowSearchReferralHandler(int limit, ReferralConnectionFactory factory)	Creates a new search referral handler.
FollowSearchReferralHandler(int limit, ReferralConnectionFactory factory, boolean tf)	Creates a new search referral handler.
FollowSearchReferralHandler(ReferralConnectionFactory factory)	Creates a new search referral handler.
FollowSearchReferralHandler(ReferralConnectionFactory factory, boolean tf)	Creates a new search referral handler.

Method Summary

Modifier and Type	Method	Description
protected SearchResultHandler[]	createNextSearchResultHandler()	Creates the next search result handler for chasing referrals, which increments the referral depth.
FollowSearchReferralHandler	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

apply, 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, apply, compose

Constructor Detail

FollowSearchReferralHandler

public FollowSearchReferralHandler()

Creates a new search referral handler.

FollowSearchReferralHandler

public FollowSearchReferralHandler(ReferralConnectionFactory factory)

Creates a new search referral handler.

Parameters:

factory - referral connection factory

FollowSearchReferralHandler

public FollowSearchReferralHandler(ReferralConnectionFactory factory,
                                   boolean tf)

Creates a new search referral handler.

Parameters:

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowSearchReferralHandler

public FollowSearchReferralHandler(int limit)

Creates a new search referral handler.

Parameters:

limit - number of referrals to follow

FollowSearchReferralHandler

public FollowSearchReferralHandler(int limit,
                                   ReferralConnectionFactory factory)

Creates a new search referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

FollowSearchReferralHandler

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

Creates a new search referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowSearchReferralHandler

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

Creates a new search referral handler.

Parameters:

limit - number of referrals to follow

depth - number of referrals followed

factory - referral connection factory

tf - whether to throw on failure to chase referrals

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

newInstance

public FollowSearchReferralHandler 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