public interface BindRequest extends Request
Modifier and Type | Field and Description |
---|---|
static byte |
AUTHENTICATION_TYPE_SASL
The authentication type value (0xA3) reserved for SASL authentication.
|
static byte |
AUTHENTICATION_TYPE_SIMPLE
The authentication type value (0x80) reserved for simple authentication.
|
static String |
OBFUSCATED_PASSWORD
The value to substitute when obfuscating passwords.
|
Modifier and Type | Method and Description |
---|---|
BindRequest |
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.
|
<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.
|
containsControl
static final byte AUTHENTICATION_TYPE_SIMPLE
static final byte AUTHENTICATION_TYPE_SASL
static final String OBFUSCATED_PASSWORD
BindRequest addControl(Control control)
Request
addControl
in interface Request
control
- The control to be added to this request.BindClient createBindClient(String serverName) throws LdapException
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()
AUTHENTICATION_TYPE_SIMPLE
(0x80
) is reserved for simple
authentication and the value AUTHENTICATION_TYPE_SASL
(
0xA3
) is reserved for SASL authentication.<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
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 Request
List
containing the controls.String getName()
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.
Copyright 2010-2017 ForgeRock AS.