Package org.ldaptive.referral

Class FollowSearchReferralHandler

java.lang.Object

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

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

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

org.ldaptive.referral.FollowSearchReferralHandler

All Implemented Interfaces:

java.util.function.Function<SearchResponse,SearchResponse>, SearchResultHandler

public class FollowSearchReferralHandler
extends AbstractFollowReferralHandler<SearchRequest,SearchResponse>
implements SearchResultHandler

Provides handling of an ldap referral for search operations.

Author:

Middleware Services

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, ReferralConnectionFactory factory)	Creates a new search referral handler.
FollowSearchReferralHandler(ReferralConnectionFactory factory)	Creates a new search referral handler.

Method Summary

Modifier and Type	Method	Description
protected SearchOperation	createReferralOperation(ConnectionFactory factory)	Creates an operation for this type of referral.
protected SearchRequest	createReferralRequest(LdapURL url)	Creates a new request for this type of referral.

Methods inherited from class org.ldaptive.referral.AbstractFollowReferralHandler

apply, followReferral, getReferralConnectionFactory, getReferralDepth, getReferralLimit

Methods inherited from class org.ldaptive.transport.MessageFunctional

getConnection, getHandle, getRequest, setConnection, setHandle, setRequest

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(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

Method Detail

createReferralRequest

protected SearchRequest createReferralRequest(LdapURL url)

Description copied from class: AbstractFollowReferralHandler

Creates a new request for this type of referral.

Specified by:

createReferralRequest in class AbstractFollowReferralHandler<SearchRequest,SearchResponse>

Parameters:

url - of the referral

Returns:

new request

createReferralOperation

protected SearchOperation createReferralOperation(ConnectionFactory factory)

Description copied from class: AbstractFollowReferralHandler

Creates an operation for this type of referral.

Specified by:

createReferralOperation in class AbstractFollowReferralHandler<SearchRequest,SearchResponse>

Parameters:

factory - to get a connection with

Returns:

new operation