Package org.ldaptive.referral

Class FollowCompareReferralHandler

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<CompareRequest,CompareResponse>

org.ldaptive.referral.FollowCompareReferralHandler

All Implemented Interfaces:

Function<CompareResponse,CompareResponse>, Freezable, ReferralResultHandler<CompareResponse>

public class FollowCompareReferralHandler
extends AbstractFollowReferralHandler<CompareRequest,CompareResponse>
implements ReferralResultHandler<CompareResponse>

Provides handling of an ldap referral for compare 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

Modifier	Constructor	Description
	FollowCompareReferralHandler()	Creates a new compare referral handler.
	FollowCompareReferralHandler(int limit)	Creates a new compare referral handler.
private	FollowCompareReferralHandler(int limit, int depth, ReferralConnectionFactory factory, boolean tf)	Creates a new compare referral handler.
	FollowCompareReferralHandler(int limit, ReferralConnectionFactory factory)	Creates a new compare referral handler.
	FollowCompareReferralHandler(int limit, ReferralConnectionFactory factory, boolean tf)	Creates a new compare referral handler.
	FollowCompareReferralHandler(ReferralConnectionFactory factory)	Creates a new compare referral handler.
	FollowCompareReferralHandler(ReferralConnectionFactory factory, boolean tf)	Creates a new compare referral handler.

Method Summary

Modifier and Type	Method	Description
protected CompareOperation	createReferralOperation(ConnectionFactory factory)	Creates an operation for this type of referral.
protected CompareRequest	createReferralRequest(LdapURL url)	Creates a new request for this type of referral.
protected Set<ResultCode>	getSuccessResultCodes()	Returns the result codes that indicate a successful referral was followed.
FollowCompareReferralHandler	newInstance()	Create a new instance of this message functional.

Methods inherited from class org.ldaptive.referral.AbstractFollowReferralHandler

apply, followReferral, getReferralConnectionFactory, getReferralDepth, getReferralLimit, 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 Details

FollowCompareReferralHandler

public FollowCompareReferralHandler()

Creates a new compare referral handler.

FollowCompareReferralHandler

public FollowCompareReferralHandler(ReferralConnectionFactory factory)

Creates a new compare referral handler.

Parameters:

factory - referral connection factory

FollowCompareReferralHandler

public FollowCompareReferralHandler(ReferralConnectionFactory factory,
 boolean tf)

Creates a new compare referral handler.

Parameters:

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowCompareReferralHandler

public FollowCompareReferralHandler(int limit)

Creates a new compare referral handler.

Parameters:

limit - number of referrals to follow

FollowCompareReferralHandler

public FollowCompareReferralHandler(int limit,
 ReferralConnectionFactory factory)

Creates a new compare referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

FollowCompareReferralHandler

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

Creates a new compare referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowCompareReferralHandler

private FollowCompareReferralHandler(int limit,
 int depth,
 ReferralConnectionFactory factory,
 boolean tf)

Creates a new compare 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 Details

createReferralRequest

protected CompareRequest createReferralRequest(LdapURL url)

Description copied from class: AbstractFollowReferralHandler

Creates a new request for this type of referral.

Specified by:

createReferralRequest in class AbstractFollowReferralHandler<CompareRequest,CompareResponse>

Parameters:

url - of the referral

Returns:

new request

createReferralOperation

protected CompareOperation createReferralOperation(ConnectionFactory factory)

Description copied from class: AbstractFollowReferralHandler

Creates an operation for this type of referral.

Specified by:

createReferralOperation in class AbstractFollowReferralHandler<CompareRequest,CompareResponse>

Parameters:

factory - to get a connection with

Returns:

new operation

getSuccessResultCodes

protected Set<ResultCode> getSuccessResultCodes()

Description copied from class: AbstractFollowReferralHandler

Returns the result codes that indicate a successful referral was followed.

Overrides:

getSuccessResultCodes in class AbstractFollowReferralHandler<CompareRequest,CompareResponse>

Returns:

success result codes

newInstance

public FollowCompareReferralHandler newInstance()

Description copied from class: MessageFunctional

Create a new instance of this message functional.

Specified by:

newInstance in class MessageFunctional<CompareRequest,CompareResponse>

Returns:

new instance of this message functional