Package org.ldaptive.referral

Class FollowModifyReferralHandler

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<ModifyRequest,ModifyResponse>

org.ldaptive.referral.FollowModifyReferralHandler

All Implemented Interfaces:

Function<ModifyResponse,ModifyResponse>, Freezable, ReferralResultHandler<ModifyResponse>

public class FollowModifyReferralHandler
extends AbstractFollowReferralHandler<ModifyRequest,ModifyResponse>
implements ReferralResultHandler<ModifyResponse>

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

Method Summary

Modifier and Type	Method	Description
protected ModifyOperation	createReferralOperation(ConnectionFactory factory)	Creates an operation for this type of referral.
protected ModifyRequest	createReferralRequest(LdapURL url)	Creates a new request for this type of referral.
FollowModifyReferralHandler	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

FollowModifyReferralHandler

public FollowModifyReferralHandler()

Creates a new modify referral handler.

FollowModifyReferralHandler

public FollowModifyReferralHandler(ReferralConnectionFactory factory)

Creates a new modify referral handler.

Parameters:

factory - referral connection factory

FollowModifyReferralHandler

public FollowModifyReferralHandler(ReferralConnectionFactory factory,
                                   boolean tf)

Creates a new modify referral handler.

Parameters:

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowModifyReferralHandler

public FollowModifyReferralHandler(int limit)

Creates a new modify referral handler.

Parameters:

limit - number of referrals to follow

FollowModifyReferralHandler

public FollowModifyReferralHandler(int limit,
                                   ReferralConnectionFactory factory)

Creates a new modify referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

FollowModifyReferralHandler

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

Creates a new modify referral handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

tf - whether to throw on failure to chase referrals

FollowModifyReferralHandler

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

Creates a new modify 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 ModifyRequest createReferralRequest(LdapURL url)

Description copied from class: AbstractFollowReferralHandler

Creates a new request for this type of referral.

Specified by:

createReferralRequest in class AbstractFollowReferralHandler<ModifyRequest,ModifyResponse>

Parameters:

url - of the referral

Returns:

new request

createReferralOperation

protected ModifyOperation createReferralOperation(ConnectionFactory factory)

Description copied from class: AbstractFollowReferralHandler

Creates an operation for this type of referral.

Specified by:

createReferralOperation in class AbstractFollowReferralHandler<ModifyRequest,ModifyResponse>

Parameters:

factory - to get a connection with

Returns:

new operation

newInstance

public FollowModifyReferralHandler newInstance()

Description copied from class: MessageFunctional

Create a new instance of this message functional.

Specified by:

newInstance in class MessageFunctional<ModifyRequest,ModifyResponse>

Returns:

new instance of this message functional