@NotMutable @ThreadSafety(level=NOT_THREADSAFE) public final class SingleUseTOTPBindRequest extends UnboundIDTOTPBindRequest
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and Alcatel-Lucent 8661
server products. These classes provide support for proprietary
functionality or for external specifications that are not considered stable
or mature enough to be guaranteed to work in an interoperable way with
other types of LDAP servers.
ReusableTOTPBindRequest
class)
which generates the one-time password should be used instead.UNBOUNDID_TOTP_MECHANISM_NAME
CRED_TYPE_SASL
VERSION_ELEMENT
Constructor and Description |
---|
SingleUseTOTPBindRequest(java.lang.String authenticationID,
java.lang.String authorizationID,
java.lang.String totpPassword,
byte[] staticPassword,
Control... controls)
Creates a new SASL TOTP bind request with the provided information.
|
SingleUseTOTPBindRequest(java.lang.String authenticationID,
java.lang.String authorizationID,
java.lang.String totpPassword,
java.lang.String staticPassword,
Control... controls)
Creates a new SASL TOTP bind request with the provided information.
|
Modifier and Type | Method and Description |
---|---|
static SingleUseTOTPBindRequest |
decodeSASLCredentials(ASN1OctetString saslCredentials,
Control... controls)
Creates a new single-use TOTP bind request from the information contained
in the provided encoded SASL credentials.
|
SingleUseTOTPBindRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
SingleUseTOTPBindRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without
impacting this request.
|
SingleUseTOTPBindRequest |
getRebindRequest(java.lang.String host,
int port)
Retrieves a bind request that may be used to re-bind using the same
credentials authentication type and credentials as previously used to
perform the initial bind.
|
protected ASN1OctetString |
getSASLCredentials()
Retrieves the encoded SASL credentials that may be included in an
UNBOUNDID-TOTP SASL bind request.
|
java.lang.String |
getTOTPPassword()
Retrieves the hard-coded TOTP password to include in the bind request.
|
void |
toCode(java.util.List<java.lang.String> lineList,
java.lang.String requestID,
int indentSpaces,
boolean includeProcessing)
Appends a number of lines comprising the Java source code that can be used
to recreate this request to the given list.
|
encodeCredentials, getAuthenticationID, getAuthorizationID, getLastMessageID, getSASLMechanismName, getStaticPassword, process, toString
getBindType, responseReceived, sendBindRequest, sendMessage
getOperationType
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setResponseTimeoutMillis, toString
public SingleUseTOTPBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String totpPassword, java.lang.String staticPassword, Control... controls)
authenticationID
- The authentication identity for the bind request.
It must not be null
, and must be in the
form "u:" followed by a username, or "dn:"
followed by a DN.authorizationID
- The authorization identity for the bind request.
It may be null
if the authorization
identity should be the same as the authentication
identity. If an authorization identity is
specified, it must be in the form "u:" followed
by a username, or "dn:" followed by a DN. The
value "dn:" may indicate an authorization
identity of the anonymous user.totpPassword
- The hard-coded TOTP password to include in the
bind request. It must not be null
.staticPassword
- The static password for the target user. It may
be null
if only the one-time password is
to be used for authentication (which may or may
not be allowed by the server).controls
- The set of controls to include in the bind
request.public SingleUseTOTPBindRequest(java.lang.String authenticationID, java.lang.String authorizationID, java.lang.String totpPassword, byte[] staticPassword, Control... controls)
authenticationID
- The authentication identity for the bind request.
It must not be null
, and must be in the
form "u:" followed by a username, or "dn:"
followed by a DN.authorizationID
- The authorization identity for the bind request.
It may be null
if the authorization
identity should be the same as the authentication
identity. If an authorization identity is
specified, it must be in the form "u:" followed
by a username, or "dn:" followed by a DN. The
value "dn:" may indicate an authorization
identity of the anonymous user.totpPassword
- The hard-coded TOTP password to include in the
bind request. It must not be null
.staticPassword
- The static password for the target user. It may
be null
if only the one-time password is
to be used for authentication (which may or may
not be allowed by the server).controls
- The set of controls to include in the bind
request.public static SingleUseTOTPBindRequest decodeSASLCredentials(ASN1OctetString saslCredentials, Control... controls) throws LDAPException
saslCredentials
- The encoded SASL credentials to be decoded in
order to create this single-use TOTP bind request.
It must not be null
.controls
- The set of controls to include in the bind
request.LDAPException
- If the provided credentials are not valid for an
UNBOUNDID-TOTP bind request.public java.lang.String getTOTPPassword()
protected ASN1OctetString getSASLCredentials()
getSASLCredentials
in class UnboundIDTOTPBindRequest
public SingleUseTOTPBindRequest getRebindRequest(java.lang.String host, int port)
getRebindRequest
in class BindRequest
host
- The address of the directory server to which the connection
is established.port
- The port of the directory server to which the connection is
established.null
to indicate that automatic
re-binding is not supported for this type of bind request.public SingleUseTOTPBindRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
public SingleUseTOTPBindRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class BindRequest
controls
- The set of controls to include in the duplicate request.public void toCode(java.util.List<java.lang.String> lineList, java.lang.String requestID, int indentSpaces, boolean includeProcessing)
toCode
in interface ReadOnlyLDAPRequest
toCode
in class SASLBindRequest
lineList
- The list to which the source code lines should
be added.requestID
- The name that should be used as an identifier
for the request. If this is null
or
empty, then a generic ID will be used.indentSpaces
- The number of spaces that should be used to
indent the generated code. It must not be
negative.includeProcessing
- Indicates whether the generated code should
include code required to actually process the
request and handle the result (if true
),
or just to generate the request (if
false
).