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
-
Field Summary
Fields inherited from class org.ldaptive.referral.AbstractFollowReferralHandler
DEFAULT_REFERRAL_LIMIT, logger, referralDepth, referralLimit -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreates a new compare referral handler.FollowCompareReferralHandler(int limit) Creates a new compare referral handler.privateFollowCompareReferralHandler(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.Creates a new compare referral handler.FollowCompareReferralHandler(ReferralConnectionFactory factory, boolean tf) Creates a new compare referral handler. -
Method Summary
Modifier and TypeMethodDescriptionprotected CompareOperationcreateReferralOperation(ConnectionFactory factory) Creates an operation for this type of referral.protected CompareRequestCreates a new request for this type of referral.protected Set<ResultCode>Returns the result codes that indicate a successful referral was followed.Create a new instance of this message functional.Methods inherited from class org.ldaptive.referral.AbstractFollowReferralHandler
apply, followReferral, getReferralConnectionFactory, getReferralDepth, getReferralLimit, getThrowOnFailureMethods inherited from class org.ldaptive.transport.MessageFunctional
getConnection, getHandle, getRequest, setConnection, setHandle, setRequestMethods inherited from class org.ldaptive.AbstractFreezable
assertMutable, freeze, freeze, freeze, isFrozen
-
Constructor Details
-
FollowCompareReferralHandler
public FollowCompareReferralHandler()Creates a new compare referral handler. -
FollowCompareReferralHandler
Creates a new compare referral handler.- Parameters:
factory- referral connection factory
-
FollowCompareReferralHandler
Creates a new compare referral handler.- Parameters:
factory- referral connection factorytf- 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
Creates a new compare referral handler.- Parameters:
limit- number of referrals to followfactory- referral connection factory
-
FollowCompareReferralHandler
Creates a new compare referral handler.- Parameters:
limit- number of referrals to followfactory- referral connection factorytf- 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 followdepth- number of referrals followedfactory- referral connection factorytf- whether to throw on failure to chase referrals
-
-
Method Details
-
createReferralRequest
Description copied from class:AbstractFollowReferralHandlerCreates a new request for this type of referral.- Specified by:
createReferralRequestin classAbstractFollowReferralHandler<CompareRequest,CompareResponse> - Parameters:
url- of the referral- Returns:
- new request
-
createReferralOperation
Description copied from class:AbstractFollowReferralHandlerCreates an operation for this type of referral.- Specified by:
createReferralOperationin classAbstractFollowReferralHandler<CompareRequest,CompareResponse> - Parameters:
factory- to get a connection with- Returns:
- new operation
-
getSuccessResultCodes
Description copied from class:AbstractFollowReferralHandlerReturns the result codes that indicate a successful referral was followed.- Overrides:
getSuccessResultCodesin classAbstractFollowReferralHandler<CompareRequest,CompareResponse> - Returns:
- success result codes
-
newInstance
Description copied from class:MessageFunctionalCreate a new instance of this message functional.- Specified by:
newInstancein classMessageFunctional<CompareRequest,CompareResponse> - Returns:
- new instance of this message functional
-