public interface AnonymousSASLBindRequest extends SASLBindRequest
Clients should provide trace information, which has no semantic value, and can be used by administrators in order to identify the user. It should take one of two forms: an Internet email address, or an opaque string that does not contain the '@' (U+0040) character and that can be interpreted by the system administrator of the client's domain. For privacy reasons, an Internet email address or other information identifying the user should only be used with permission from the user.
Modifier and Type | Field and Description |
---|---|
static String |
SASL_MECHANISM_NAME
The name of the SASL mechanism that does not provide any authentication
but rather uses anonymous access.
|
AUTHENTICATION_TYPE_SASL, AUTHENTICATION_TYPE_SIMPLE, OBFUSCATED_PASSWORD
Modifier and Type | Method and Description |
---|---|
AnonymousSASLBindRequest |
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 SASL bind
request as defined by the LDAP protocol, which is always
0xA3 . |
<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, which is always the empty string for SASL authentication.
|
String |
getSASLMechanism()
Returns the SASL mechanism for this SASL bind request.
|
String |
getTraceString()
Returns the trace information, which has no semantic value, and can be
used by administrators in order to identify the user.
|
AnonymousSASLBindRequest |
setTraceString(String traceString)
Sets the trace information, which has no semantic value, and can be used
by administrators in order to identify the user.
|
containsControl
static final String SASL_MECHANISM_NAME
AnonymousSASLBindRequest addControl(Control control)
Request
addControl
in interface BindRequest
addControl
in interface Request
addControl
in interface SASLBindRequest
control
- The control to be added to this request.BindClient createBindClient(String serverName) throws LdapException
BindRequest
createBindClient
in interface BindRequest
createBindClient
in interface SASLBindRequest
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()
0xA3
.getAuthenticationType
in interface BindRequest
getAuthenticationType
in interface SASLBindRequest
<C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
Request
getControl
in interface BindRequest
getControl
in interface Request
getControl
in interface SASLBindRequest
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
getControls
in interface SASLBindRequest
List
containing the controls.String getName()
getName
in interface BindRequest
getName
in interface SASLBindRequest
String getSASLMechanism()
SASLBindRequest
getSASLMechanism
in interface SASLBindRequest
String getTraceString()
AnonymousSASLBindRequest setTraceString(String traceString)
traceString
- The trace information, which has no semantic value, and can be
used by administrators in order to identify the user.UnsupportedOperationException
- If this anonymous SASL request does not permit the trace
information to be set.NullPointerException
- If traceString
was null
.Copyright 2010-2017 ForgeRock AS.