|
|||||||||
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.ConsumeSingleUseTokenExtendedRequest
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ConsumeSingleUseTokenExtendedRequest
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 that can be used to consume a single-use token that was generated and provided to the user through the deliver single-use token extended operation. Once a token has been consumed, it cannot be used again, although a new token can be generated and delivered to the user if necessary.
ConsumeSingleUseTokenRequestValue ::= SEQUENCE { userDN LDAPDN, tokenID OCTET STRING, tokenValue OCTET STRING ... }
DeliverSingleUseTokenExtendedResult
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
CONSUME_SINGLE_USE_TOKEN_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.51) for the consume single-use token extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
ConsumeSingleUseTokenExtendedRequest(ExtendedRequest request)
Decodes the provided extended request as a consume single-use token extended request. |
|
ConsumeSingleUseTokenExtendedRequest(java.lang.String userDN,
java.lang.String tokenID,
java.lang.String tokenValue,
Control... controls)
Creates a new consume single-use token extended request with the provided information. |
Method Summary | |
---|---|
ConsumeSingleUseTokenExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ConsumeSingleUseTokenExtendedRequest |
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 |
getTokenID()
Retrieves the identifier for the token to consume. |
java.lang.String |
getTokenValue()
Retrieves the value for the token to consume. |
java.lang.String |
getUserDN()
Retrieves the DN of the user whose account contains the token to consume. |
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 CONSUME_SINGLE_USE_TOKEN_REQUEST_OID
Constructor Detail |
---|
public ConsumeSingleUseTokenExtendedRequest(java.lang.String userDN, java.lang.String tokenID, java.lang.String tokenValue, Control... controls)
userDN
- The DN of the user whose account contains the token to
consume. It must not be null
.tokenID
- The identifier for the token to consume. It must not
be null
.tokenValue
- The value for the single-use token to consume. It
must not be null
.controls
- An optional set of controls to include in the request.
It may be null
or empty if no controls are
required.public ConsumeSingleUseTokenExtendedRequest(ExtendedRequest request) throws LDAPException
request
- The extended request to decode as a consume single-use
token extended request.
LDAPException
- If the provided extended request cannot be decoded
as a consume single-use token request.Method Detail |
---|
public java.lang.String getUserDN()
public java.lang.String getTokenID()
public java.lang.String getTokenValue()
public ConsumeSingleUseTokenExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public ConsumeSingleUseTokenExtendedRequest 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 |