Package org.ldaptive.referral

Class FollowAddReferralHandler

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<AddRequest,AddResponse>

org.ldaptive.referral.FollowAddReferralHandler

All Implemented Interfaces:

Function<AddResponse,AddResponse>, Freezable, ReferralResultHandler<AddResponse>

public class FollowAddReferralHandler
extends AbstractFollowReferralHandler<AddRequest,AddResponse>
implements ReferralResultHandler<AddResponse>

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

Method Summary

Modifier and Type	Method	Description
protected AddOperation	createReferralOperation(ConnectionFactory factory)	Creates an operation for this type of referral.
protected AddRequest	createReferralRequest(LdapURL url)	Creates a new request for this type of referral.
FollowAddReferralHandler	newInstance()	Create a new instance of this message functional.

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

FollowAddReferralHandler

public FollowAddReferralHandler()

Creates a new add referral handler.

FollowAddReferralHandler

public FollowAddReferralHandler(ReferralConnectionFactory factory)

Creates a new add referral handler.

Parameters:

factory - referral connection factory

FollowAddReferralHandler

public FollowAddReferralHandler(ReferralConnectionFactory factory,
                                boolean tf)

Creates a new add referral handler.

Parameters:

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowAddReferralHandler

public FollowAddReferralHandler(int limit)

Creates a new add referral handler.

Parameters:

limit - number of referrals to follow

FollowAddReferralHandler

public FollowAddReferralHandler(int limit,
                                ReferralConnectionFactory factory)

Creates a new add referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

FollowAddReferralHandler

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

Creates a new add referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowAddReferralHandler

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

Creates a new add 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

createReferralRequest

protected AddRequest createReferralRequest(LdapURL url)

Description copied from class: AbstractFollowReferralHandler

Creates a new request for this type of referral.

Specified by:

createReferralRequest in class AbstractFollowReferralHandler<AddRequest,AddResponse>

Parameters:

url - of the referral

Returns:

new request

createReferralOperation

protected AddOperation createReferralOperation(ConnectionFactory factory)

Description copied from class: AbstractFollowReferralHandler

Creates an operation for this type of referral.

Specified by:

createReferralOperation in class AbstractFollowReferralHandler<AddRequest,AddResponse>

Parameters:

factory - to get a connection with

Returns:

new operation

newInstance

public FollowAddReferralHandler newInstance()

Description copied from class: MessageFunctional

Create a new instance of this message functional.

Specified by:

newInstance in class MessageFunctional<AddRequest,AddResponse>

Returns:

new instance of this message functional