Package org.ldaptive.transport

Class DefaultCompareOperationHandle

java.lang.Object

org.ldaptive.transport.DefaultOperationHandle<CompareRequest,CompareResponse>

org.ldaptive.transport.DefaultCompareOperationHandle

All Implemented Interfaces:

CompareOperationHandle, OperationHandle<CompareRequest,CompareResponse>

public class DefaultCompareOperationHandle
extends DefaultOperationHandle<CompareRequest,CompareResponse>
implements CompareOperationHandle

Handle that notifies on the components of a compare request.

Author:

Middleware Services

Field Summary

Fields inherited from class org.ldaptive.transport.DefaultOperationHandle

logger

Constructor Summary

Constructors

Constructor	Description
DefaultCompareOperationHandle(CompareRequest req, TransportConnection conn, java.time.Duration timeout)	Creates a new compare operation handle.

Method Summary

Modifier and Type	Method	Description
CompareResponse	await()	Waits for a result or reports a timeout exception.
void	compare(CompareResponse response)	Invokes onCompare.
DefaultCompareOperationHandle	onCompare(CompareValueHandler... function)	Sets the function to execute when a compare result is received.
DefaultCompareOperationHandle	onComplete(CompleteHandler function)	Sets the function to execute when the operation completes.
DefaultCompareOperationHandle	onControl(ResponseControlHandler... function)	Sets the functions to execute when a control is received.
DefaultCompareOperationHandle	onException(ExceptionHandler function)	Sets the function to execute when an exception occurs.
DefaultCompareOperationHandle	onIntermediate(IntermediateResponseHandler... function)	Sets the functions to execute when an intermediate response is received.
DefaultCompareOperationHandle	onReferral(ReferralHandler... function)	Sets the functions to execute when a referral is received.
DefaultCompareOperationHandle	onResult(ResultHandler... function)	Sets the functions to execute when a result is received.
DefaultCompareOperationHandle	onUnsolicitedNotification(UnsolicitedNotificationHandler... function)	Sets the functions to execute when an unsolicited notification is received.
DefaultCompareOperationHandle	send()	Sends this request to the server.
DefaultCompareOperationHandle	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.CompareOperationHandle

execute

Methods inherited from interface org.ldaptive.OperationHandle

abandon, cancel, getReceivedTime, getSentTime

Constructor Detail

DefaultCompareOperationHandle

public DefaultCompareOperationHandle(CompareRequest req,
                                     TransportConnection conn,
                                     java.time.Duration timeout)

Creates a new compare operation handle.

Parameters:

req - compare request to expect a response for

conn - the request will be executed on

timeout - duration to wait for a response

Method Detail

send

public DefaultCompareOperationHandle send()

Description copied from interface: OperationHandle

Sends this request to the server.

Specified by:

send in interface CompareOperationHandle

Specified by:

send in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

send in class DefaultOperationHandle<CompareRequest,CompareResponse>

Returns:

this handle

await

public CompareResponse await()
                      throws LdapException

Description copied from interface: OperationHandle

Waits for a result or reports a timeout exception.

Specified by:

await in interface CompareOperationHandle

Specified by:

await in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

await in class DefaultOperationHandle<CompareRequest,CompareResponse>

Returns:

result of the operation or empty if the operation is abandoned

Throws:

LdapException - if an error occurs executing the request

onResult

public DefaultCompareOperationHandle onResult(ResultHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a result is received.

Specified by:

onResult in interface CompareOperationHandle

Specified by:

onResult in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onResult in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute on a result

Returns:

this handle

onControl

public DefaultCompareOperationHandle onControl(ResponseControlHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a control is received.

Specified by:

onControl in interface CompareOperationHandle

Specified by:

onControl in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onControl in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute on a control

Returns:

this handle

onReferral

public DefaultCompareOperationHandle onReferral(ReferralHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a referral is received.

Specified by:

onReferral in interface CompareOperationHandle

Specified by:

onReferral in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onReferral in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute on a referral

Returns:

this handle

onIntermediate

public DefaultCompareOperationHandle onIntermediate(IntermediateResponseHandler... function)

Description copied from interface: OperationHandle

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

Specified by:

onIntermediate in interface CompareOperationHandle

Specified by:

onIntermediate in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onIntermediate in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute on an intermediate response

Returns:

this handle

onUnsolicitedNotification

public DefaultCompareOperationHandle onUnsolicitedNotification(UnsolicitedNotificationHandler... function)

Description copied from interface: OperationHandle

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

Specified by:

onUnsolicitedNotification in interface CompareOperationHandle

Specified by:

onUnsolicitedNotification in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onUnsolicitedNotification in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute on an unsolicited notification

Returns:

this handle

onException

public DefaultCompareOperationHandle onException(ExceptionHandler function)

Description copied from interface: OperationHandle

Sets the function to execute when an exception occurs.

Specified by:

onException in interface CompareOperationHandle

Specified by:

onException in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onException in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute when an exception occurs

Returns:

this handle

throwIf

public DefaultCompareOperationHandle 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 CompareOperationHandle

Specified by:

throwIf in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

throwIf in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to determine whether to throw an exception

Returns:

this handle

onComplete

public DefaultCompareOperationHandle onComplete(CompleteHandler function)

Description copied from interface: OperationHandle

Sets the function to execute when the operation completes.

Specified by:

onComplete in interface CompareOperationHandle

Specified by:

onComplete in interface OperationHandle<CompareRequest,CompareResponse>

Overrides:

onComplete in class DefaultOperationHandle<CompareRequest,CompareResponse>

Parameters:

function - to execute on completion

Returns:

this handle

onCompare

public DefaultCompareOperationHandle onCompare(CompareValueHandler... function)

Sets the function to execute when a compare result is received.

Specified by:

onCompare in interface CompareOperationHandle

Parameters:

function - to execute on a compare result

Returns:

this handle

compare

public void compare(CompareResponse response)

Invokes onCompare.

Parameters:

response - compare response

toString

public java.lang.String toString()

Overrides:

toString in class DefaultOperationHandle<CompareRequest,CompareResponse>