Package org.ldaptive.transport

Class DefaultExtendedOperationHandle

java.lang.Object

org.ldaptive.transport.DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

org.ldaptive.transport.DefaultExtendedOperationHandle

All Implemented Interfaces:

ExtendedOperationHandle, OperationHandle<ExtendedRequest,ExtendedResponse>

public class DefaultExtendedOperationHandle
extends DefaultOperationHandle<ExtendedRequest,ExtendedResponse>
implements ExtendedOperationHandle

Handle that notifies on the components of an extended request.

Author:

Middleware Services

Field Summary

Fields inherited from class org.ldaptive.transport.DefaultOperationHandle

logger

Constructor Summary

Constructors

Constructor	Description
DefaultExtendedOperationHandle(ExtendedRequest req, TransportConnection conn, java.time.Duration timeout)	Creates a new extended operation handle.

Method Summary

Modifier and Type	Method	Description
ExtendedResponse	await()	Waits for a result or reports a timeout exception.
void	extended(ExtendedResponse response)	Invokes onExtended.
DefaultExtendedOperationHandle	onComplete(CompleteHandler function)	Sets the function to execute when the operation completes.
DefaultExtendedOperationHandle	onControl(ResponseControlHandler... function)	Sets the functions to execute when a control is received.
DefaultExtendedOperationHandle	onException(ExceptionHandler function)	Sets the function to execute when an exception occurs.
DefaultExtendedOperationHandle	onExtended(ExtendedValueHandler... function)	Sets the function to execute when an extended response is received.
DefaultExtendedOperationHandle	onIntermediate(IntermediateResponseHandler... function)	Sets the functions to execute when an intermediate response is received.
DefaultExtendedOperationHandle	onReferral(ReferralHandler... function)	Sets the functions to execute when a referral is received.
DefaultExtendedOperationHandle	onResult(ResultHandler... function)	Sets the functions to execute when a result is received.
DefaultExtendedOperationHandle	onUnsolicitedNotification(UnsolicitedNotificationHandler... function)	Sets the functions to execute when an unsolicited notification is received.
DefaultExtendedOperationHandle	send()	Sends this request to the server.
DefaultExtendedOperationHandle	throwIf(ResultPredicate function)	Sets the function to determine whether an exception should be raised by a particular result.
java.lang.String	toString()

Methods inherited from class org.ldaptive.transport.DefaultOperationHandle

abandon, abandon, cancel, consumedMessage, control, exception, getMessageID, getOnComplete, getOnControl, getOnException, getOnIntermediate, getOnReferral, getOnResult, getOnUnsolicitedNotification, getReceivedTime, getRequest, getSentTime, getThrowCondition, hasConsumedMessage, initializeMessageFunctional, intermediate, messageID, referral, result, sent, unsolicitedNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ldaptive.extended.ExtendedOperationHandle

execute

Methods inherited from interface org.ldaptive.OperationHandle

abandon, cancel, getReceivedTime, getSentTime

Constructor Detail

DefaultExtendedOperationHandle

public DefaultExtendedOperationHandle(ExtendedRequest req,
                                      TransportConnection conn,
                                      java.time.Duration timeout)

Creates a new extended operation handle.

Parameters:

req - search request to expect a response for

conn - the request will be executed on

timeout - duration to wait for a response

Method Detail

send

public DefaultExtendedOperationHandle send()

Description copied from interface: OperationHandle

Sends this request to the server.

Specified by:

send in interface ExtendedOperationHandle

Specified by:

send in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

send in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Returns:

this handle

await

public ExtendedResponse await()
                       throws LdapException

Description copied from interface: OperationHandle

Waits for a result or reports a timeout exception.

Specified by:

await in interface ExtendedOperationHandle

Specified by:

await in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

await in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Returns:

result of the operation or empty if the operation is abandoned

Throws:

LdapException - if an error occurs executing the request

onResult

public DefaultExtendedOperationHandle onResult(ResultHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a result is received.

Specified by:

onResult in interface ExtendedOperationHandle

Specified by:

onResult in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onResult in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a result

Returns:

this handle

onControl

public DefaultExtendedOperationHandle onControl(ResponseControlHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a control is received.

Specified by:

onControl in interface ExtendedOperationHandle

Specified by:

onControl in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onControl in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a control

Returns:

this handle

onReferral

public DefaultExtendedOperationHandle onReferral(ReferralHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a referral is received.

Specified by:

onReferral in interface ExtendedOperationHandle

Specified by:

onReferral in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onReferral in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a referral

Returns:

this handle

onIntermediate

public DefaultExtendedOperationHandle onIntermediate(IntermediateResponseHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when an intermediate response is received.

Specified by:

onIntermediate in interface ExtendedOperationHandle

Specified by:

onIntermediate in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onIntermediate in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on an intermediate response

Returns:

this handle

onUnsolicitedNotification

public DefaultExtendedOperationHandle onUnsolicitedNotification(UnsolicitedNotificationHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when an unsolicited notification is received.

Specified by:

onUnsolicitedNotification in interface ExtendedOperationHandle

Specified by:

onUnsolicitedNotification in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onUnsolicitedNotification in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on an unsolicited notification

Returns:

this handle

onException

public DefaultExtendedOperationHandle onException(ExceptionHandler function)

Description copied from interface: OperationHandle

Sets the function to execute when an exception occurs.

Specified by:

onException in interface ExtendedOperationHandle

Specified by:

onException in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onException in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute when an exception occurs

Returns:

this handle

throwIf

public DefaultExtendedOperationHandle throwIf(ResultPredicate function)

Description copied from interface: OperationHandle

Sets the function to determine whether an exception should be raised by a particular result.

Specified by:

throwIf in interface ExtendedOperationHandle

Specified by:

throwIf in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

throwIf in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to determine whether to throw an exception

Returns:

this handle

onComplete

public DefaultExtendedOperationHandle onComplete(CompleteHandler function)

Description copied from interface: OperationHandle

Sets the function to execute when the operation completes.

Specified by:

onComplete in interface ExtendedOperationHandle

Specified by:

onComplete in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Overrides:

onComplete in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on completion

Returns:

this handle

onExtended

public DefaultExtendedOperationHandle onExtended(ExtendedValueHandler... function)

Sets the function to execute when an extended response is received.

Specified by:

onExtended in interface ExtendedOperationHandle

Parameters:

function - to execute on an extended response

Returns:

this handle

extended

public void extended(ExtendedResponse response)

Invokes onExtended.

Parameters:

response - extended response

toString

public java.lang.String toString()

Overrides:

toString in class DefaultOperationHandle<ExtendedRequest,ExtendedResponse>