public interface GenericBindRequest extends BindRequest
ResultCode.AUTH_METHOD_NOT_SUPPORTED
.AUTHENTICATION_TYPE_SASL, AUTHENTICATION_TYPE_SIMPLE, OBFUSCATED_PASSWORD
Modifier and Type | Method and Description |
---|---|
GenericBindRequest |
addControl(Control control)
Adds the provided control to this request.
|
BindClient |
createBindClient(String serverName)
Creates a new bind client which can be used to perform the authentication
process.
|
byte |
getAuthenticationType()
Returns the authentication mechanism identifier for this generic bind
request as defined by the LDAP protocol.
|
byte[] |
getAuthenticationValue()
Returns the authentication information for this bind request.
|
<C extends Control> |
getControl(ControlDecoder<C> decoder,
DecodeOptions options)
Decodes and returns the first control in this request having an OID
corresponding to the provided control decoder.
|
List<Control> |
getControls()
Returns a
List containing the controls included with this
request. |
String |
getName()
Returns the name of the Directory object that the client wishes to bind
as.
|
GenericBindRequest |
setAuthenticationType(byte type)
Sets the authentication mechanism identifier for this generic bind
request.
|
GenericBindRequest |
setAuthenticationValue(byte[] bytes)
Sets the authentication information for this generic bind request in a
form defined by the authentication mechanism.
|
GenericBindRequest |
setName(String name)
Sets the name of the Directory object that the client wishes to bind as.
|
containsControl
GenericBindRequest addControl(Control control)
Request
addControl
in interface BindRequest
addControl
in interface Request
control
- The control to be added to this request.BindClient createBindClient(String serverName) throws LdapException
BindRequest
createBindClient
in interface BindRequest
serverName
- The non-null fully-qualified host name of the server to
authenticate to.LdapException
- If an error occurred while creating the bind client context.byte getAuthenticationType()
BindRequest
BindRequest.AUTHENTICATION_TYPE_SIMPLE
(0x80
) is reserved for simple
authentication and the value BindRequest.AUTHENTICATION_TYPE_SASL
(
0xA3
) is reserved for SASL authentication.getAuthenticationType
in interface BindRequest
byte[] getAuthenticationValue()
Unless otherwise indicated, implementations will store a reference to the returned byte array, allowing applications to overwrite any sensitive data such as passwords after it has been used.
<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface BindRequest
getControl
in interface Request
C
- The type of control to be decoded and returned.decoder
- The control decoder.options
- The set of decode options which should be used when decoding
the control.null
if the control is not
included with this request.DecodeException
- If the control could not be decoded because it was malformed
in some way (e.g. the control value was missing, or its
content could not be decoded).List<Control> getControls()
Request
List
containing the controls included with this
request. The returned List
may be modified if permitted by this
request.getControls
in interface BindRequest
getControls
in interface Request
List
containing the controls.String getName()
BindRequest
null
) when used for
anonymous binds, or when using SASL authentication. The server shall not
dereference any aliases in locating the named object.
The LDAP protocol defines the Bind name to be a distinguished name, however some LDAP implementations have relaxed this constraint and allow other identities to be used, such as the user's email address.
getName
in interface BindRequest
GenericBindRequest setAuthenticationType(byte type)
0
is reserved for simple authentication,
1
and 2
are reserved but unused, and 3
is
reserved for SASL authentication.type
- The authentication mechanism identifier for this generic bind
request.UnsupportedOperationException
- If this generic bind request does not permit the
authentication type to be set.GenericBindRequest setAuthenticationValue(byte[] bytes)
Unless otherwise indicated, implementations will store a reference to the returned byte array, allowing applications to overwrite any sensitive data such as passwords after it has been used.
bytes
- The authentication information for this generic bind request
in a form defined by the authentication mechanism.UnsupportedOperationException
- If this generic bind request does not permit the
authentication bytes to be set.NullPointerException
- If bytes
was null
.GenericBindRequest setName(String name)
null
when used for of anonymous
binds, or when using SASL authentication. The server shall not
dereference any aliases in locating the named object.
The LDAP protocol defines the Bind name to be a distinguished name, however some LDAP implementations have relaxed this constraint and allow other identities to be used, such as the user's email address.
name
- The name of the Directory object that the client wishes to
bind as.UnsupportedOperationException
- If this bind request does not permit the distinguished name
to be set.NullPointerException
- If name
was null
.Copyright 2010-2017 ForgeRock AS.