Package org.ldaptive.extended

Interface ExtendedOperationHandle

All Superinterfaces:

OperationHandle<ExtendedRequest,ExtendedResponse>

All Known Implementing Classes:

DefaultExtendedOperationHandle

public interface ExtendedOperationHandle
extends OperationHandle<ExtendedRequest,ExtendedResponse>

Handle that notifies on the components of an extended request.

Method Summary

Modifier and Type	Method	Description
ExtendedResponse	await()	Waits for a result or reports a timeout exception.
default ExtendedResponse	execute()	Convenience method that invokes OperationHandle.send() followed by OperationHandle.await().
ExtendedOperationHandle	onComplete(CompleteHandler function)	Sets the function to execute when the operation completes.
ExtendedOperationHandle	onControl(ResponseControlHandler... function)	Sets the functions to execute when a control is received.
ExtendedOperationHandle	onException(ExceptionHandler function)	Sets the function to execute when an exception occurs.
ExtendedOperationHandle	onExtended(ExtendedValueHandler... function)	Sets the function to execute when an extended result is received.
ExtendedOperationHandle	onIntermediate(IntermediateResponseHandler... function)	Sets the functions to execute when an intermediate response is received.
ExtendedOperationHandle	onReferral(ReferralHandler... function)	Sets the functions to execute when a referral is received.
ExtendedOperationHandle	onReferralResult(ReferralResultHandler<ExtendedResponse> function)	Sets the functions to execute when a response is complete and contains a referral result code.
ExtendedOperationHandle	onResult(ResultHandler... function)	Sets the functions to execute when a result is received.
ExtendedOperationHandle	onUnsolicitedNotification(UnsolicitedNotificationHandler... function)	Sets the functions to execute when an unsolicited notification is received.
ExtendedOperationHandle	send()	Sends this request to the server.
ExtendedOperationHandle	throwIf(ResultPredicate function)	Sets the function to determine whether an exception should be raised by a particular result.

Methods inherited from interface org.ldaptive.OperationHandle

abandon, cancel, getAbandonedTime, getReceivedTime, getSentTime

Method Details

send

ExtendedOperationHandle send()

Description copied from interface: OperationHandle

Sends this request to the server.

Specified by:

send in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Returns:

this handle

await

ExtendedResponse await()
                throws LdapException

Description copied from interface: OperationHandle

Waits for a result or reports a timeout exception.

Specified by:

await in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Returns:

result of the operation or empty if the operation is abandoned

Throws:

LdapException - if an error occurs executing the request

execute

default ExtendedResponse execute()
                          throws LdapException

Description copied from interface: OperationHandle

Convenience method that invokes OperationHandle.send() followed by OperationHandle.await(). Provides a single method to make a synchronous request.

Specified by:

execute in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Returns:

result of the operation or empty if the operation is abandoned

Throws:

LdapException - if an error occurs executing the request

onResult

ExtendedOperationHandle onResult(ResultHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a result is received.

Specified by:

onResult in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a result

Returns:

this handle

onControl

ExtendedOperationHandle onControl(ResponseControlHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a control is received.

Specified by:

onControl in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a control

Returns:

this handle

onReferral

ExtendedOperationHandle onReferral(ReferralHandler... function)

Description copied from interface: OperationHandle

Sets the functions to execute when a referral is received.

Specified by:

onReferral in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a referral

Returns:

this handle

onIntermediate

ExtendedOperationHandle onIntermediate(IntermediateResponseHandler... function)

Description copied from interface: OperationHandle

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

Specified by:

onIntermediate in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on an intermediate response

Returns:

this handle

onUnsolicitedNotification

ExtendedOperationHandle onUnsolicitedNotification(UnsolicitedNotificationHandler... function)

Description copied from interface: OperationHandle

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

Specified by:

onUnsolicitedNotification in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on an unsolicited notification

Returns:

this handle

onReferralResult

ExtendedOperationHandle onReferralResult(ReferralResultHandler<ExtendedResponse> function)

Description copied from interface: OperationHandle

Sets the functions to execute when a response is complete and contains a referral result code.

Specified by:

onReferralResult in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on a referral response

Returns:

this handle

onException

ExtendedOperationHandle onException(ExceptionHandler function)

Description copied from interface: OperationHandle

Sets the function to execute when an exception occurs.

Specified by:

onException in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute when an exception occurs

Returns:

this handle

throwIf

ExtendedOperationHandle 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 OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to determine whether to throw an exception

Returns:

this handle

onComplete

ExtendedOperationHandle onComplete(CompleteHandler function)

Description copied from interface: OperationHandle

Sets the function to execute when the operation completes.

Specified by:

onComplete in interface OperationHandle<ExtendedRequest,ExtendedResponse>

Parameters:

function - to execute on completion

Returns:

this handle

onExtended

ExtendedOperationHandle onExtended(ExtendedValueHandler... function)

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

Parameters:

function - to execute on an extended result

Returns:

this handle