Class BindRequestDsml
- java.lang.Object
-
- org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator<E>
-
- org.apache.directory.api.dsmlv2.request.AbstractRequestDsml<E>
-
- org.apache.directory.api.dsmlv2.request.AbstractResultResponseRequestDsml<BindRequest,BindResponse>
-
- org.apache.directory.api.dsmlv2.request.BindRequestDsml
-
- All Implemented Interfaces:
DsmlDecorator<BindRequest>
,AbandonableRequest
,BindRequest
,Message
,Request
,ResultResponseRequest
,SingleReplyRequest
public class BindRequestDsml extends AbstractResultResponseRequestDsml<BindRequest,BindResponse> implements BindRequest
DSML Decorator for BindRequest- Author:
- Apache Directory Project
-
-
Constructor Summary
Constructors Constructor Description BindRequestDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of AuthRequestDsml.BindRequestDsml(LdapApiService codec, BindRequest ldapMessage)
Creates a new getDecoratedMessage() of AuthRequestDsml.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BindRequest
addAllControls(Control[] controls)
Adds an array of controls to this Message.BindRequest
addControl(Control control)
Adds a control to this Message.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.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.MessageTypeEnum
getType()
Gets the LDAP message type code associated with this Message.boolean
getVersion3()
Gets whether or not the Ldap v3 protocol is used.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 requestBindRequest
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 isSimple)
Sets the authentication mechanism to simple or to SASL based authentication.BindRequest
setVersion3(boolean isVersion3)
Sets whether or not the LDAP v3 or v2 protocol is used.org.dom4j.Element
toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.-
Methods inherited from class org.apache.directory.api.dsmlv2.request.AbstractResultResponseRequestDsml
abandon, addAbandonListener, computeLength, encode, getResultResponse, isAbandoned
-
Methods inherited from class org.apache.directory.api.dsmlv2.request.AbstractRequestDsml
hasResponse
-
Methods inherited from class org.apache.directory.api.dsmlv2.AbstractDsmlMessageDecorator
get, getCodecService, getControl, getControls, getCurrentControl, getDecorated, getMessageId, hasControl, put
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.AbandonableRequest
abandon, addAbandonListener, isAbandoned
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Message
get, getControl, getControls, getMessageId, hasControl, put
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.Request
hasResponse
-
Methods inherited from interface org.apache.directory.api.ldap.model.message.ResultResponseRequest
getResultResponse
-
-
-
-
Constructor Detail
-
BindRequestDsml
public BindRequestDsml(LdapApiService codec)
Creates a new getDecoratedMessage() of AuthRequestDsml.- Parameters:
codec
- The LDAP Service to use
-
BindRequestDsml
public BindRequestDsml(LdapApiService codec, BindRequest ldapMessage)
Creates a new getDecoratedMessage() of AuthRequestDsml.- Parameters:
codec
- The LDAP Service to useldapMessage
- the message to decorate
-
-
Method Detail
-
getType
public MessageTypeEnum getType()
Gets the LDAP message type code associated with this Message. Each request and response type has a unique message type code defined by the protocol in RFC 2251.- Specified by:
getType
in interfaceMessage
- Overrides:
getType
in classAbstractDsmlMessageDecorator<BindRequest>
- Returns:
- the message type code.
-
toDsml
public org.dom4j.Element toDsml(org.dom4j.Element root)
Creates the Request Element and adds RequestID and Controls.- Specified by:
toDsml
in interfaceDsmlDecorator<BindRequest>
- Overrides:
toDsml
in classAbstractResultResponseRequestDsml<BindRequest,BindResponse>
- Parameters:
root
- the root element- Returns:
- the Request Element of the given name containing
-
getResponseType
public MessageTypeEnum getResponseType()
Gets the protocol response message type for this request which produces at least one response.- Specified by:
getResponseType
in interfaceSingleReplyRequest
- Returns:
- the message type of the response.
-
isSimple
public boolean isSimple()
Checks to see if the authentication mechanism is simple and not SASL based.- Specified by:
isSimple
in interfaceBindRequest
- 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 interfaceBindRequest
- Returns:
- true if the mechanism is simple false if it is SASL based.
-
setSimple
public BindRequest setSimple(boolean isSimple)
Sets the authentication mechanism to simple or to SASL based authentication.- Specified by:
setSimple
in interfaceBindRequest
- Parameters:
isSimple
- 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 interfaceBindRequest
- 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 interfaceBindRequest
- 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 interfaceBindRequest
- Parameters:
credentials
- the credentials if authentication is simple- 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 interfaceBindRequest
- 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 interfaceBindRequest
- 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 interfaceBindRequest
- 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 interfaceBindRequest
- 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 interfaceBindRequest
- 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 interfaceBindRequest
- Returns:
- true if client using version 3 false if it is version 2.
-
setVersion3
public BindRequest setVersion3(boolean isVersion3)
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 interfaceBindRequest
- Parameters:
isVersion3
- 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
-
getSaslMechanism
public String getSaslMechanism()
Gets the SASL mechanism String associated with this BindRequest if the bind operation is using SASL.- Specified by:
getSaslMechanism
in interfaceBindRequest
- 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 interfaceBindRequest
- Parameters:
saslMechanism
- the SASL mechanism- Returns:
- The BindRequest instance
-
setMessageId
public BindRequest setMessageId(int messageId)
Sets the Message ID for this request- Specified by:
setMessageId
in interfaceBindRequest
- Specified by:
setMessageId
in interfaceMessage
- Overrides:
setMessageId
in classAbstractDsmlMessageDecorator<BindRequest>
- Parameters:
messageId
- The message Id- Returns:
- A Message reference
-
addControl
public BindRequest addControl(Control control)
Adds a control to this Message.- Specified by:
addControl
in interfaceBindRequest
- Specified by:
addControl
in interfaceMessage
- Overrides:
addControl
in classAbstractDsmlMessageDecorator<BindRequest>
- Parameters:
control
- the control to add.- Returns:
- A Message reference
-
addAllControls
public BindRequest addAllControls(Control[] controls)
Adds an array of controls to this Message.- Specified by:
addAllControls
in interfaceBindRequest
- Specified by:
addAllControls
in interfaceMessage
- Overrides:
addAllControls
in classAbstractDsmlMessageDecorator<BindRequest>
- Parameters:
controls
- the controls to add.- Returns:
- A Message reference
-
removeControl
public BindRequest removeControl(Control control)
Deletes a control removing it from this Message.- Specified by:
removeControl
in interfaceBindRequest
- Specified by:
removeControl
in interfaceMessage
- Overrides:
removeControl
in classAbstractDsmlMessageDecorator<BindRequest>
- Parameters:
control
- the control to remove.- Returns:
- A Message reference
-
-