org.ldaptive.referral

Class AbstractReferralHandler<Q extends Request,S>

java.lang.Object

org.ldaptive.referral.AbstractReferralHandler<Q,S>

Type Parameters:

Q - type of ldap request

S - type of ldap response

All Implemented Interfaces:

Handler<Q,Response<S>>, ReferralHandler<Q,S>

Direct Known Subclasses:

AddReferralHandler, CompareReferralHandler, DeleteReferralHandler, ModifyDnReferralHandler, ModifyReferralHandler, SearchReferralHandler

public abstract class AbstractReferralHandler<Q extends Request,S>
extends java.lang.Object
implements ReferralHandler<Q,S>

Common implementation of referral handling.

Field Summary

Fields

Modifier and Type	Field and Description
private ReferralConnectionFactory	connectionFactory Referral connection factory.
protected static ReferralConnectionFactory	DEFAULT_CONNECTION_FACTORY Default referral connection factory.
protected static int	DEFAULT_REFERRAL_LIMIT Default referral limit.
protected org.slf4j.Logger	logger Logger for this class.
private int	referralDepth Referral depth.
private int	referralLimit Referral limit.

Constructor Summary

Constructors

Constructor and Description
AbstractReferralHandler(int limit, int depth, ReferralConnectionFactory factory) Creates a new abstract referral handler.

Method Summary

Modifier and Type	Method and Description
protected abstract Operation<Q,S>	createReferralOperation(Connection conn) Creates an operation for this type of referral.
protected abstract Q	createReferralRequest(Q request, LdapURL url) Creates a new request for this type of referral.
protected Response<S>	followReferral(Connection conn, Q request, java.lang.String[] referralUrls) Follows the supplied referral URLs in order until a SUCCESS or REFERRAL_LIMIT_EXCEEDED occurs.
ReferralConnectionFactory	getReferralConnectionFactory() Returns the referral connection factory.
int	getReferralDepth() Returns the referral depth of this handler.
int	getReferralLimit() Returns the maximum number of referrals to follow.
HandlerResult<Response<S>>	handle(Connection conn, Q request, Response<S> response) Handle the supplied result.
HandlerResult<Response<S>>	handle(Connection conn, Q request, java.lang.String[] referralUrls) Implementation that does not require the response.
void	initializeRequest(Q request) Initialize the request for use with this referral handler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_REFERRAL_LIMIT

protected static final int DEFAULT_REFERRAL_LIMIT

Default referral limit. Value is 10.

See Also:

Constant Field Values

DEFAULT_CONNECTION_FACTORY

protected static final ReferralConnectionFactory DEFAULT_CONNECTION_FACTORY

Default referral connection factory. Uses DefaultConnectionFactory.

logger

protected final org.slf4j.Logger logger

Logger for this class.

referralLimit

private final int referralLimit

Referral limit.

referralDepth

private final int referralDepth

Referral depth.

connectionFactory

private final ReferralConnectionFactory connectionFactory

Referral connection factory.

Constructor Detail

AbstractReferralHandler

public AbstractReferralHandler(int limit,
                               int depth,
                               ReferralConnectionFactory factory)

Creates a new abstract referral handler.

Parameters:

limit - number of referrals to follow

depth - number of referrals followed

factory - referral connection factory

Method Detail

getReferralLimit

public int getReferralLimit()

Returns the maximum number of referrals to follow.

Returns:

referral limit

getReferralDepth

public int getReferralDepth()

Returns the referral depth of this handler.

Returns:

referral depth

getReferralConnectionFactory

public ReferralConnectionFactory getReferralConnectionFactory()

Returns the referral connection factory.

Returns:

referral connection factory

createReferralRequest

protected abstract Q createReferralRequest(Q request,
                                           LdapURL url)

Creates a new request for this type of referral.

Parameters:

request - of the original operation

url - of the referral

Returns:

new request

createReferralOperation

protected abstract Operation<Q,S> createReferralOperation(Connection conn)

Creates an operation for this type of referral.

Parameters:

conn - to execute the operation on

Returns:

new operation

followReferral

protected Response<S> followReferral(Connection conn,
                                     Q request,
                                     java.lang.String[] referralUrls)
                              throws LdapException

Follows the supplied referral URLs in order until a SUCCESS or REFERRAL_LIMIT_EXCEEDED occurs. If neither of those conditions occurs this method returns null.

Parameters:

conn - the original operation occurred on

request - of the operation that produced a referral

referralUrls - produced by the request

Returns:

referral response

Throws:

LdapException - if a REFERRAL_LIMIT_EXCEEDED in encountered

handle

public HandlerResult<Response<S>> handle(Connection conn,
                                         Q request,
                                         Response<S> response)
                                  throws LdapException

Description copied from interface: Handler

Handle the supplied result.

Specified by:

handle in interface Handler<Q extends Request,Response<S>>

Specified by:

handle in interface ReferralHandler<Q extends Request,S>

Parameters:

conn - connection the operation was executed on

request - executed by the operation

response - produced from the operation

Returns:

handler result

Throws:

LdapException - if handling fails

handle

public HandlerResult<Response<S>> handle(Connection conn,
                                         Q request,
                                         java.lang.String[] referralUrls)
                                  throws LdapException

Implementation that does not require the response.

Parameters:

conn - the operation occurred on

request - the operation executed

referralUrls - encountered in the operation

Returns:

handler result

Throws:

LdapException - if an error occurs following referrals

initializeRequest

public void initializeRequest(Q request)

Description copied from interface: ReferralHandler

Initialize the request for use with this referral handler.

Specified by:

initializeRequest in interface ReferralHandler<Q extends Request,S>

Parameters:

request - to initialize for this referral handler