Class ConsumeSingleUseTokenExtendedRequest
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPRequest
-
- com.unboundid.ldap.sdk.ExtendedRequest
-
- com.unboundid.ldap.sdk.unboundidds.extensions.ConsumeSingleUseTokenExtendedRequest
-
- All Implemented Interfaces:
ProtocolOp
,ReadOnlyLDAPRequest
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ConsumeSingleUseTokenExtendedRequest extends ExtendedRequest
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.
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 Nokia/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.
This extended request has an OID of "1.3.6.1.4.1.30221.2.6.51" and it must have a value with the following encoding:ConsumeSingleUseTokenRequestValue ::= SEQUENCE { userDN LDAPDN, tokenID OCTET STRING, tokenValue OCTET STRING ... }
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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, toCode, writeTo
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getReferralConnector, getReferralConnectorInternal, getReferralDepth, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setReferralConnector, setReferralDepth, setResponseTimeoutMillis, toString
-
-
-
-
Field Detail
-
CONSUME_SINGLE_USE_TOKEN_REQUEST_OID
@NotNull public static final 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.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ConsumeSingleUseTokenExtendedRequest
public ConsumeSingleUseTokenExtendedRequest(@NotNull java.lang.String userDN, @NotNull java.lang.String tokenID, @NotNull java.lang.String tokenValue, @Nullable Control... controls)
Creates a new consume single-use token extended request with the provided information.- Parameters:
userDN
- The DN of the user whose account contains the token to consume. It must not benull
.tokenID
- The identifier for the token to consume. It must not benull
.tokenValue
- The value for the single-use token to consume. It must not benull
.controls
- An optional set of controls to include in the request. It may benull
or empty if no controls are required.
-
ConsumeSingleUseTokenExtendedRequest
public ConsumeSingleUseTokenExtendedRequest(@NotNull ExtendedRequest request) throws LDAPException
Decodes the provided extended request as a consume single-use token extended request.- Parameters:
request
- The extended request to decode as a consume single-use token extended request.- Throws:
LDAPException
- If the provided extended request cannot be decoded as a consume single-use token request.
-
-
Method Detail
-
getUserDN
@NotNull public java.lang.String getUserDN()
Retrieves the DN of the user whose account contains the token to consume.- Returns:
- The DN of the user whose account contains the token to consume.
-
getTokenID
@NotNull public java.lang.String getTokenID()
Retrieves the identifier for the token to consume.- Returns:
- The identifier for the token to consume.
-
getTokenValue
@NotNull public java.lang.String getTokenValue()
Retrieves the value for the token to consume.- Returns:
- The value for the token to consume.
-
duplicate
@NotNull public ConsumeSingleUseTokenExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type..- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
@NotNull public ConsumeSingleUseTokenExtendedRequest duplicate(@Nullable Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type..- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Overrides:
duplicate
in classExtendedRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
getExtendedRequestName
@NotNull public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.- Overrides:
getExtendedRequestName
in classExtendedRequest
- Returns:
- The user-friendly name for this extended request, or the OID if no user-friendly name is available.
-
toString
public void toString(@NotNull java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.- Specified by:
toString
in interfaceProtocolOp
- Specified by:
toString
in interfaceReadOnlyLDAPRequest
- Overrides:
toString
in classExtendedRequest
- Parameters:
buffer
- The buffer to which to append a string representation of this request.
-
-