|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.ValidateTOTPPasswordExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ValidateTOTPPasswordExtendedRequest
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of an extended request which may be used to validate a TOTP password for a user. Note that this should not be used as an alternative to authentication because it does not perform password policy processing. Rather, this extended operation should be used only to obtain additional assurance about the identity of a user that has already been authenticated through some other means.
ValidateTOTPPasswordRequest ::= SEQUENCE { userDN [0] LDAPDN, totpPassword [1] OCTET STRING, ... }
Field Summary | |
---|---|
static java.lang.String |
VALIDATE_TOTP_PASSWORD_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.15) for the validate TOTP password extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
ValidateTOTPPasswordExtendedRequest(ExtendedRequest extendedRequest)
Creates a new validate TOTP password extended request from the provided generic extended request. |
|
ValidateTOTPPasswordExtendedRequest(java.lang.String userDN,
java.lang.String totpPassword,
Control... controls)
Creates a new validate TOTP password extended request with the provided information. |
Method Summary | |
---|---|
ValidateTOTPPasswordExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ValidateTOTPPasswordExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
java.lang.String |
getTOTPPassword()
Retrieves the TOTP password to validate. |
java.lang.String |
getUserDN()
Retrieves the DN of the user for whom to validate the TOTP password. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, process, responseReceived, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VALIDATE_TOTP_PASSWORD_REQUEST_OID
Constructor Detail |
---|
public ValidateTOTPPasswordExtendedRequest(java.lang.String userDN, java.lang.String totpPassword, Control... controls)
userDN
- The DN of the user for whom to validate the TOTP
password.totpPassword
- The TOTP password to validate.controls
- The set of controls to include in the request.public ValidateTOTPPasswordExtendedRequest(ExtendedRequest extendedRequest) throws LDAPException
extendedRequest
- The generic extended request to parse as a
validate TOTP extended request.
LDAPException
- If a problem is encountered while attempting to
parse the provided extended request.Method Detail |
---|
public java.lang.String getUserDN()
public java.lang.String getTOTPPassword()
public ValidateTOTPPasswordExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public ValidateTOTPPasswordExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |