Package org.ldaptive.transport.netty

Class NettyConnection.BindOperationHandle

java.lang.Object

org.ldaptive.transport.DefaultOperationHandle<BindRequest,BindResponse>

org.ldaptive.transport.netty.NettyConnection.BindOperationHandle

All Implemented Interfaces:

OperationHandle<BindRequest,BindResponse>

Enclosing class:

NettyConnection

public final class NettyConnection.BindOperationHandle
extends DefaultOperationHandle<BindRequest,BindResponse>

Bind specific operation handle that locks other operations until the bind completes.

Field Summary

Fields inherited from class org.ldaptive.transport.DefaultOperationHandle

logger

Constructor Summary

Constructors

Constructor	Description
BindOperationHandle(BindRequest req, TransportConnection conn, Duration timeout)	Creates a new bind operation handle.

Method Summary

Modifier and Type	Method	Description
BindResponse	await()	Waits for a result or reports a timeout exception.
BindResponse	execute()	Convenience method that invokes OperationHandle.send() followed by OperationHandle.await().
protected BindResponse	processReferralResult(BindResponse done, ReferralResultHandler<BindResponse> handler)	Invokes the supplied referral result handler and returns the result of that handler.
NettyConnection.BindOperationHandle	send()	Sends this request to the server.

Methods inherited from class org.ldaptive.transport.DefaultOperationHandle

abandon, abandon, cancel, consumedMessage, consumedMessage, control, evaluateThrowCondition, exception, finalizeResult, getAbandonedTime, getMessageID, getOnComplete, getOnControl, getOnException, getOnIntermediate, getOnReferral, getOnReferralResult, getOnResult, getOnUnsolicitedNotification, getReceivedTime, getRequest, getResponseTimeoutCondition, getSentTime, getThrowCondition, hasConsumedMessage, initializeMessageFunctional, initializeMessageFunctional, intermediate, messageID, notifyExceptionHandlers, onComplete, onControl, onException, onIntermediate, onReferral, onReferralResult, onResult, onUnsolicitedNotification, processHandlerException, processResult, referral, result, sent, throwIf, toString, unsolicitedNotification

Methods inherited from class java.lang.Object

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

Constructor Detail

BindOperationHandle

BindOperationHandle(BindRequest req,
                    TransportConnection conn,
                    Duration timeout)

Creates a new bind operation handle.

Parameters:

req - bind request to expect a response for

conn - the request will be executed on

timeout - duration to wait for a response

Method Detail

send

public NettyConnection.BindOperationHandle send()

Description copied from interface: OperationHandle

Sends this request to the server.

Specified by:

send in interface OperationHandle<BindRequest,BindResponse>

Overrides:

send in class DefaultOperationHandle<BindRequest,BindResponse>

Returns:

this handle

await

public BindResponse await()

Description copied from interface: OperationHandle

Waits for a result or reports a timeout exception.

Specified by:

await in interface OperationHandle<BindRequest,BindResponse>

Overrides:

await in class DefaultOperationHandle<BindRequest,BindResponse>

Returns:

result of the operation or empty if the operation is abandoned

processReferralResult

protected BindResponse processReferralResult(BindResponse done,
                                             ReferralResultHandler<BindResponse> handler)
                                      throws LdapException

Description copied from class: DefaultOperationHandle

Invokes the supplied referral result handler and returns the result of that handler.

Overrides:

processReferralResult in class DefaultOperationHandle<BindRequest,BindResponse>

Parameters:

done - operation result

handler - to invoke

Returns:

result returned by the handler

Throws:

LdapException - if the handler throws an LdapException

execute

public BindResponse 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.

Returns:

result of the operation or empty if the operation is abandoned

Throws:

LdapException - if an error occurs executing the request