Package org.ldaptive.referral

Class FollowSearchResultReferenceHandler

java.lang.Object

org.ldaptive.transport.MessageFunctional<Q,S>

org.ldaptive.transport.MessageFunctional.Function<Q,S,S,S>

org.ldaptive.referral.AbstractFollowReferralHandler<SearchRequest,SearchResponse>

org.ldaptive.referral.FollowSearchResultReferenceHandler

All Implemented Interfaces:

Function<SearchResponse,SearchResponse>, SearchResultHandler

public class FollowSearchResultReferenceHandler
extends AbstractFollowReferralHandler<SearchRequest,SearchResponse>
implements SearchResultHandler

Provides handling of an ldap continuation reference for search 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
	FollowSearchResultReferenceHandler()	Creates a new search result reference handler.
	FollowSearchResultReferenceHandler(int limit)	Creates a new search result reference handler.
private	FollowSearchResultReferenceHandler(int limit, int depth, ReferralConnectionFactory factory)	Creates a new search result reference handler.
	FollowSearchResultReferenceHandler(int limit, ReferralConnectionFactory factory)	Creates a new search result reference handler.
	FollowSearchResultReferenceHandler(ReferralConnectionFactory factory)	Creates a new search result reference handler.

Method Summary

Modifier and Type	Method	Description
SearchResponse	apply(SearchResponse result)
protected SearchOperation	createReferralOperation(ConnectionFactory factory)	Creates an operation for this type of referral.
protected SearchRequest	createReferralRequest(LdapURL url)	Creates a new request for this type of referral.

Methods inherited from class org.ldaptive.referral.AbstractFollowReferralHandler

followReferral, getReferralConnectionFactory, getReferralDepth, getReferralLimit

Methods inherited from class org.ldaptive.transport.MessageFunctional

getConnection, getHandle, getRequest, setConnection, setHandle, setRequest

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, compose

Constructor Detail

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler()

Creates a new search result reference handler.

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(ReferralConnectionFactory factory)

Creates a new search result reference handler.

Parameters:

factory - referral connection factory

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(int limit)

Creates a new search result reference handler.

Parameters:

limit - number of referrals to follow

FollowSearchResultReferenceHandler

public FollowSearchResultReferenceHandler(int limit,
                                          ReferralConnectionFactory factory)

Creates a new search result reference handler.

Parameters:

limit - number of referrals to follow

factory - referral connection factory

FollowSearchResultReferenceHandler

private FollowSearchResultReferenceHandler(int limit,
                                           int depth,
                                           ReferralConnectionFactory factory)

Creates a new search result reference handler.

Parameters:

limit - number of referrals to follow

depth - number of referrals followed

factory - referral connection factory

Method Detail

createReferralRequest

protected SearchRequest createReferralRequest(LdapURL url)

Description copied from class: AbstractFollowReferralHandler

Creates a new request for this type of referral.

Specified by:

createReferralRequest in class AbstractFollowReferralHandler<SearchRequest,SearchResponse>

Parameters:

url - of the referral

Returns:

new request

createReferralOperation

protected SearchOperation createReferralOperation(ConnectionFactory factory)

Description copied from class: AbstractFollowReferralHandler

Creates an operation for this type of referral.

Specified by:

createReferralOperation in class AbstractFollowReferralHandler<SearchRequest,SearchResponse>

Parameters:

factory - to get a connection with

Returns:

new operation

apply

public SearchResponse apply(SearchResponse result)

Specified by:

apply in interface Function<SearchResponse,SearchResponse>

Overrides:

apply in class AbstractFollowReferralHandler<SearchRequest,SearchResponse>