com.unboundid.ldap.sdk.unboundidds.extensions

Class GenerateTOTPSharedSecretExtendedResult

java.lang.Object

com.unboundid.ldap.sdk.LDAPResult

com.unboundid.ldap.sdk.ExtendedResult

com.unboundid.ldap.sdk.unboundidds.extensions.GenerateTOTPSharedSecretExtendedResult

All Implemented Interfaces:

LDAPResponse, java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GenerateTOTPSharedSecretExtendedResult
extends ExtendedResult

This class provides an implementation of an extended result that may be used to provide the client with a TOTP shared secret generated by the server in response to a GenerateTOTPSharedSecretExtendedRequest.

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.

If the extended request was processed successfully, then this result will have an OID of 1.3.6.1.4.1.30221.2.6.57 and a value with the following encoding:

   GenerateTOTPSharedSecretResult ::= SEQUENCE {
        totpSharedSecret     [0] OCTET STRING }
        ... }
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GENERATE_TOTP_SHARED_SECRET_RESULT_OID The OID (1.3.6.1.4.1.30221.2.6.57) for the generate TOTP shared secret extended result.

Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse

NO_CONTROLS

Constructor Summary

Constructors

Constructor and Description
GenerateTOTPSharedSecretExtendedResult(ExtendedResult extendedResult) Creates a new generate TOTP shared secret extended result from the provided extended result.
GenerateTOTPSharedSecretExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.String totpSharedSecret, Control... responseControls) Creates a new generate TOTP shared secret extended result with the provided information.
GenerateTOTPSharedSecretExtendedResult(int messageID, java.lang.String totpSharedSecret, Control... responseControls) Generates a new generate TOTP shared secret extended result for the case in which the server was able to generate the requested TOTP shared secret.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExtendedResultName() Retrieves the user-friendly name for the extended result, if available.
java.lang.String	getTOTPSharedSecret() Retrieves the base32-encoded representation of the TOTP shared secret generated by the server, if available.
void	toString(java.lang.StringBuilder buffer) Appends a string representation of this extended result to the provided buffer.

Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult

getOID, getValue, hasValue, toString

Methods inherited from class com.unboundid.ldap.sdk.LDAPResult

getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GENERATE_TOTP_SHARED_SECRET_RESULT_OID

@NotNull
public static final java.lang.String GENERATE_TOTP_SHARED_SECRET_RESULT_OID

The OID (1.3.6.1.4.1.30221.2.6.57) for the generate TOTP shared secret extended result.

See Also:

Constant Field Values

Constructor Detail

GenerateTOTPSharedSecretExtendedResult

public GenerateTOTPSharedSecretExtendedResult(int messageID,
                                              @NotNull
                                              java.lang.String totpSharedSecret,
                                              @Nullable
                                              Control... responseControls)

Generates a new generate TOTP shared secret extended result for the case in which the server was able to generate the requested TOTP shared secret.

Parameters:

messageID - The message ID for the LDAP message that is associated with this LDAP result.

totpSharedSecret - The base32-encoded representation of the TOTP shared secret generated by the server. It must not be null.

responseControls - The set of controls from the response, if available.

GenerateTOTPSharedSecretExtendedResult

public GenerateTOTPSharedSecretExtendedResult(int messageID,
                                              @NotNull
                                              ResultCode resultCode,
                                              @Nullable
                                              java.lang.String diagnosticMessage,
                                              @Nullable
                                              java.lang.String matchedDN,
                                              @Nullable
                                              java.lang.String[] referralURLs,
                                              @Nullable
                                              java.lang.String totpSharedSecret,
                                              @Nullable
                                              Control... responseControls)

Creates a new generate TOTP shared secret extended result with the provided information.

Parameters:

messageID - The message ID for the LDAP message that is associated with this LDAP result.

resultCode - The result code from the response.

diagnosticMessage - The diagnostic message from the response, if available.

matchedDN - The matched DN from the response, if available.

referralURLs - The set of referral URLs from the response, if available.

totpSharedSecret - The base32-encoded representation of the TOTP shared secret generated by the server, if available.

responseControls - The set of controls from the response, if available.

GenerateTOTPSharedSecretExtendedResult

public GenerateTOTPSharedSecretExtendedResult(@NotNull
                                              ExtendedResult extendedResult)
                                       throws LDAPException

Creates a new generate TOTP shared secret extended result from the provided extended result.

Parameters:

extendedResult - The extended result to be decoded as a generate TOTP shared secret extended result. It must not be null.

Throws:

LDAPException - If the provided extended result cannot be decoded as a generate TOTP shared secret result.

Method Detail

getTOTPSharedSecret

@Nullable
public java.lang.String getTOTPSharedSecret()

Retrieves the base32-encoded representation of the TOTP shared secret generated by the server, if available.

Returns:

The base32-encoded representation of the TOTP shared secret generated by the server, or null if none was provided.

getExtendedResultName

@NotNull
public java.lang.String getExtendedResultName()

Retrieves the user-friendly name for the extended result, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.

Overrides:

getExtendedResultName in class ExtendedResult

Returns:

The user-friendly name for this extended request, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.

toString

public void toString(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this extended result to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class ExtendedResult

Parameters:

buffer - The buffer to which a string representation of this extended result will be appended.