org.apache.directory.api.ldap.model.message
Class BindRequestImpl

java.lang.Object
  org.apache.directory.api.ldap.model.message.AbstractMessage
      org.apache.directory.api.ldap.model.message.AbstractRequest
          org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest
              org.apache.directory.api.ldap.model.message.BindRequestImpl

All Implemented Interfaces:

AbandonableRequest, BindRequest, Message, Request, ResultResponseRequest<BindResponse>, SingleReplyRequest<BindResponse>

public class BindRequestImpl
extends AbstractAbandonableRequest
implements BindRequest

Bind protocol operation request which authenticates and begins a client session. Does not yet contain interfaces for SASL authentication mechanisms.

Author:

Apache Directory Project

Field Summary

BindResponse

response The associated response

Fields inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

controls

Fields inherited from interface org.apache.directory.api.ldap.model.message.BindRequest

RESP_TYPE, TYPE

Constructor Summary

BindRequestImpl()
Creates an BindRequest implementation to bind to an LDAP server.

Method Summary

void	abandon() RFC 2251/4511 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.
BindRequest	addAllControls(Control[] controls) Adds an array of controls to this Message.
BindRequest	addControl(Control control) Adds a control to this Message.
boolean	equals(Object obj) Checks to see if two messages are equivalent.
byte[]	getCredentials() Gets the simple credentials associated with a simple authentication attempt or null if this request uses SASL authentication mechanisms.
Dn	getDn() Gets the DN of the subject in this authentication request.
String	getName() Gets the name of the subject in this authentication request.
MessageTypeEnum	getResponseType() Gets the protocol response message type for this request which produces at least one response.
BindResponse	getResultResponse() The result containing response for this request.
String	getSaslMechanism() Gets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL.
boolean	getSimple() Checks to see if the authentication mechanism is simple and not SASL based.
boolean	getVersion3() Gets whether or not the Ldap v3 protocol is used.
int	hashCode()
boolean	isSimple() Checks to see if the authentication mechanism is simple and not SASL based.
boolean	isVersion3() Checks to see if the Ldap v3 protocol is used.
BindRequest	removeControl(Control control) Deletes a control removing it from this Message.
BindRequest	setCredentials(byte[] credentials) Sets the simple credentials associated with a simple authentication attempt.
BindRequest	setCredentials(String credentials) Sets the simple credentials associated with a simple authentication attempt.
BindRequest	setDn(Dn dn) Sets the DN of the subject in this authentication request.
BindRequest	setMessageId(int messageId) Sets the Message ID for this request
BindRequest	setName(String name) Sets the name of the subject in this authentication request.
BindRequest	setSaslMechanism(String saslMechanism) Sets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL.
BindRequest	setSimple(boolean simple) Sets the authentication mechanism to simple or to SASL based authentication.
BindRequest	setVersion3(boolean version3) Sets whether or not the LDAP v3 or v2 protocol is used.
String	toString() Get a String representation of a BindRequest

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractAbandonableRequest

addAbandonListener, isAbandoned

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractRequest

hasResponse

Methods inherited from class org.apache.directory.api.ldap.model.message.AbstractMessage

get, getControl, getControls, getMessageId, getType, hasControl, put, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.directory.api.ldap.model.message.Request

hasResponse

Methods inherited from interface org.apache.directory.api.ldap.model.message.Message

get, getControl, getControls, getMessageId, getType, hasControl, put

Methods inherited from interface org.apache.directory.api.ldap.model.message.AbandonableRequest

addAbandonListener, isAbandoned

Field Detail

response

public BindResponse response

The associated response

Constructor Detail

BindRequestImpl

public BindRequestImpl()

Creates an BindRequest implementation to bind to an LDAP server.

Method Detail

isSimple

public boolean isSimple()

Checks to see if the authentication mechanism is simple and not SASL based.

Specified by:

isSimple in interface BindRequest

Returns:

true if the mechanism is simple false if it is SASL based.

getSimple

public boolean getSimple()

Checks to see if the authentication mechanism is simple and not SASL based.

Specified by:

getSimple in interface BindRequest

Returns:

true if the mechanism is simple false if it is SASL based.

setSimple

public BindRequest setSimple(boolean simple)

Sets the authentication mechanism to simple or to SASL based authentication.

Specified by:

setSimple in interface BindRequest

Parameters:

simple - true if authentication is simple, false otherwise.

Returns:

The BindRequest instance

getCredentials

public byte[] getCredentials()

Gets the simple credentials associated with a simple authentication attempt or null if this request uses SASL authentication mechanisms.

Specified by:

getCredentials in interface BindRequest

Returns:

null if the mechanism is SASL, or the credentials if it is simple.

setCredentials

public BindRequest setCredentials(String credentials)

Sets the simple credentials associated with a simple authentication attempt. Ignored if this request uses SASL authentication mechanisms.

Specified by:

setCredentials in interface BindRequest

Parameters:

credentials - the credentials if authentication is simple

Returns:

The BindRequest instance

setCredentials

public BindRequest setCredentials(byte[] credentials)

Sets the simple credentials associated with a simple authentication attempt. Ignored if this request uses SASL authentication mechanisms.

Specified by:

setCredentials in interface BindRequest

Parameters:

credentials - the credentials if authentication is simple

Returns:

The BindRequest instance

getSaslMechanism

public String getSaslMechanism()

Gets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL.

Specified by:

getSaslMechanism in interface BindRequest

Returns:

the SASL mechanism or null if the bind operation is simple

setSaslMechanism

public BindRequest setSaslMechanism(String saslMechanism)

Sets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL.

Specified by:

setSaslMechanism in interface BindRequest

Parameters:

saslMechanism - the SASL mechanism

Returns:

The BindRequest instance

getName

public String getName()

Gets the name of the subject in this authentication request. This field may take on a null value (a zero length string) for the purposes of anonymous binds, when authentication has been performed at a lower layer, or when using SASL credentials with a mechanism that includes the name in the credentials.

Specified by:

getName in interface BindRequest

Returns:

the name of the authenticating user.

setName

public BindRequest setName(String name)

Sets the name of the subject in this authentication request. This field may take on a null value (or a zero length string) for the purposes of anonymous binds, when authentication has been performed at a lower layer, or when using SASL credentials with a mechanism that includes the name in the credentials.

Specified by:

setName in interface BindRequest

Parameters:

name - the name of the authenticating user - leave null for anonymous user.

Returns:

The BindRequest instance

getDn

public Dn getDn()

Gets the DN of the subject in this authentication request. This field may take on a null value (a zero length string) for the purposes of anonymous binds, when authentication has been performed at a lower layer, or when using SASL credentials with a mechanism that includes the DN in the credentials.

Specified by:

getDn in interface BindRequest

Returns:

the DN of the authenticating user.

setDn

public BindRequest setDn(Dn dn)

Sets the DN of the subject in this authentication request. This field may take on a null value (or a zero length string) for the purposes of anonymous binds, when authentication has been performed at a lower layer, or when using SASL credentials with a mechanism that includes the DN in the credentials.

Specified by:

setDn in interface BindRequest

Parameters:

dn - the DN of the authenticating user - leave null for anonymous user.

Returns:

The BindRequest instance

isVersion3

public boolean isVersion3()

Checks to see if the Ldap v3 protocol is used. Normally this would extract a version number from the bind request sent by the client indicating the version of the protocol to be used in this protocol session. The integer is either a 2 or a 3 at the moment. We thought it was better to just check if the protocol used is 3 or not rather than use an type-safe enumeration type for a binary value. If an LDAPv4 comes out then we shall convert the return type to a type safe enumeration.

Specified by:

isVersion3 in interface BindRequest

Returns:

true if client using version 3 false if it is version 2.

getVersion3

public boolean getVersion3()

Gets whether or not the Ldap v3 protocol is used. Normally this would extract a version number from the bind request sent by the client indicating the version of the protocol to be used in this protocol session. The integer is either a 2 or a 3 at the moment. We thought it was better to just check if the protocol used is 3 or not rather than use an type-safe enumeration type for a binary value. If an LDAPv4 comes out then we shall convert the return type to a type safe enumeration.

Specified by:

getVersion3 in interface BindRequest

Returns:

true if client using version 3 false if it is version 2.

setVersion3

public BindRequest setVersion3(boolean version3)

Sets whether or not the LDAP v3 or v2 protocol is used. Normally this would extract a version number from the bind request sent by the client indicating the version of the protocol to be used in this protocol session. The integer is either a 2 or a 3 at the moment. We thought it was better to just check if the protocol used is 3 or not rather than use an type-safe enumeration type for a binary value. If an LDAPv4 comes out then we shall convert the return type to a type safe enumeration.

Specified by:

setVersion3 in interface BindRequest

Parameters:

version3 - if true the client will be exhibiting version 3 bind behavior, If false is used version 2 behavior will be exhibited.

Returns:

The BindRequest instance

setMessageId

public BindRequest setMessageId(int messageId)

Sets the Message ID for this request

Specified by:

setMessageId in interface BindRequest

Specified by:

setMessageId in interface Message

Overrides:

setMessageId in class AbstractMessage

Parameters:

messageId - The message Id

Returns:

A Message reference

addControl

public BindRequest addControl(Control control)
                       throws MessageException

Adds a control to this Message.

Specified by:

addControl in interface BindRequest

Specified by:

addControl in interface Message

Overrides:

addControl in class AbstractMessage

Parameters:

control - the control to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

addAllControls

public BindRequest addAllControls(Control[] controls)
                           throws MessageException

Adds an array of controls to this Message.

Specified by:

addAllControls in interface BindRequest

Specified by:

addAllControls in interface Message

Overrides:

addAllControls in class AbstractMessage

Parameters:

controls - the controls to add.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or they are not known etc.

removeControl

public BindRequest removeControl(Control control)
                          throws MessageException

Deletes a control removing it from this Message.

Specified by:

removeControl in interface BindRequest

Specified by:

removeControl in interface Message

Overrides:

removeControl in class AbstractMessage

Parameters:

control - the control to remove.

Returns:

A Message reference

Throws:

MessageException - if controls cannot be added to this Message or the control is not known etc.

getResponseType

public MessageTypeEnum getResponseType()

Gets the protocol response message type for this request which produces at least one response.

Specified by:

getResponseType in interface SingleReplyRequest<BindResponse>

Returns:

the message type of the response.

getResultResponse

public BindResponse getResultResponse()

The result containing response for this request.

Specified by:

getResultResponse in interface ResultResponseRequest<BindResponse>

Returns:

the result containing response for this request

abandon

public void abandon()

RFC 2251/4511 [Section 4.11]: Abandon, Bind, Unbind, and StartTLS operations cannot be abandoned.

Specified by:

abandon in interface AbandonableRequest

Overrides:

abandon in class AbstractAbandonableRequest

equals

public boolean equals(Object obj)

Checks to see if two messages are equivalent. Messages equivalence does not factor in parameters accessible through the get() and put() operations, nor do they factor in the Lockable properties of the Message. Only the type, controls, and the messageId are evaluated for equality.

Overrides:

equals in class AbstractRequest

Parameters:

obj - the object to compare this Message to for equality

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRequest

Returns:

the instance's hash code

See Also:

Object.hashCode()

toString

public String toString()

Get a String representation of a BindRequest

Overrides:

toString in class Object

Returns:

A BindRequest String