Package org.ldaptive

Class BindOperation

java.lang.Object

org.ldaptive.AbstractOperation<BindRequest,BindResponse>

org.ldaptive.BindOperation

All Implemented Interfaces:

Operation<BindRequest,BindResponse>

public class BindOperation
extends AbstractOperation<BindRequest,BindResponse>

Executes an ldap bind operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BindOperation.Builder	Bind operation builder.

Nested classes/interfaces inherited from class org.ldaptive.AbstractOperation

AbstractOperation.AbstractBuilder<B,T extends AbstractOperation>

Constructor Summary

Constructors

Constructor	Description
BindOperation()	Default constructor.
BindOperation(ConnectionFactory factory)	Creates a new bind operation.

Method Summary

Modifier and Type	Method	Description
static BindOperation.Builder	builder()	Creates a builder for this class.
static BindOperation	copy(BindOperation operation)	Returns a new bind operation with the same properties as the supplied operation.
static BindOperation	copy(BindOperation operation, boolean deep)	Returns a new bind operation with the same properties as the supplied operation.
BindResponse	execute(BindRequest request)	Executes a bind request.
static BindResponse	execute(ConnectionFactory factory, BindRequest request)	Executes a bind request.
OperationHandle<BindRequest,BindResponse>	send(BindRequest request)	Sends a bind request.
static OperationHandle<BindRequest,BindResponse>	send(ConnectionFactory factory, BindRequest request)	Sends a bind request.

Methods inherited from class org.ldaptive.AbstractOperation

configureHandle, configureRequest, copy, getConnectionFactory, getControlHandlers, getExceptionHandler, getIntermediateResponseHandlers, getReferralHandlers, getReferralResultHandler, getRequestHandlers, getResultHandlers, getThrowCondition, getUnsolicitedNotificationHandlers, setConnectionFactory, setControlHandlers, setExceptionHandler, setIntermediateResponseHandlers, setReferralHandlers, setReferralResultHandler, setRequestHandlers, setResultHandlers, setThrowCondition, setUnsolicitedNotificationHandlers, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BindOperation

public BindOperation()

Default constructor.

BindOperation

public BindOperation(ConnectionFactory factory)

Creates a new bind operation.

Parameters:

factory - connection factory

Method Detail

send

public OperationHandle<BindRequest,BindResponse> send(BindRequest request)
                                                     throws LdapException

Sends a bind request. See OperationHandle.send().

Parameters:

request - bind request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

send

public static OperationHandle<BindRequest,BindResponse> send(ConnectionFactory factory,
                                                                   BindRequest request)
                                                            throws LdapException

Sends a bind request. See OperationHandle.send().

Parameters:

factory - connection factory

request - bind request

Returns:

operation handle

Throws:

LdapException - if the connection cannot be opened

execute

public BindResponse execute(BindRequest request)
                     throws LdapException

Executes a bind request. See OperationHandle.execute().

Parameters:

request - bind request

Returns:

bind result

Throws:

LdapException - if the connection cannot be opened

execute

public static BindResponse execute(ConnectionFactory factory,
                                   BindRequest request)
                            throws LdapException

Executes a bind request. See OperationHandle.execute().

Parameters:

factory - connection factory

request - bind request

Returns:

bind result

Throws:

LdapException - if the connection cannot be opened

copy

public static BindOperation copy(BindOperation operation)

Returns a new bind operation with the same properties as the supplied operation.

Parameters:

operation - to copy

Returns:

copy of the supplied bind operation

copy

public static BindOperation copy(BindOperation operation,
                                 boolean deep)

Returns a new bind operation with the same properties as the supplied operation.

Parameters:

operation - to copy

deep - whether to make a deep copy

Returns:

copy of the supplied bind operation

builder

public static BindOperation.Builder builder()

Creates a builder for this class.

Returns:

new builder