com.nimbusds.oauth2.sdk.auth

Class Secret

java.lang.Object

com.nimbusds.oauth2.sdk.auth.Secret

@Immutable
public final class Secret
extends Object

Secret or password. The secret should be erased when no longer in use.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BYTE_LENGTH The default byte length of generated secrets.

Constructor Summary

Constructors

Constructor and Description
Secret() Creates a new secret with a randomly generated 256-bit (32-byte) value, Base64URL-encoded.
Secret(int byteLength) Creates a new secret with a randomly generated value of the specified byte length, Base64URL-encoded.
Secret(int byteLength, Date expDate) Creates a new secret with a randomly generated value of the specified byte length, Base64URL-encoded, and the specified expiration date.
Secret(String value) Creates a new secret with the specified value.
Secret(String value, Date expDate) Creates a new secret with the specified value and expiration date.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object object) Overrides Object.equals().
void	erase() Erases of the value of this secret.
boolean	expired() Checks is this secret has expired.
Date	getExpirationDate() Gets the expiration date of this secret.
String	getValue() Gets the value of this secret.
byte[]	getValueBytes() Gets the value of this secret.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BYTE_LENGTH

public static final int DEFAULT_BYTE_LENGTH

The default byte length of generated secrets.

See Also:

Constant Field Values

Constructor Detail

Secret

public Secret(String value)

Creates a new secret with the specified value.

Parameters:

value - The secret value. Must not be null or empty string.

Secret

public Secret(String value,
      Date expDate)

Creates a new secret with the specified value and expiration date.

Parameters:

value - The secret value. Must be UTF-8 encoded, not null or empty string.

expDate - The expiration date, null if not specified.

Secret

public Secret(int byteLength)

Creates a new secret with a randomly generated value of the specified byte length, Base64URL-encoded.

Parameters:

byteLength - The byte length of the secret value to generate. Must be greater than one.

Secret

public Secret(int byteLength,
      Date expDate)

Creates a new secret with a randomly generated value of the specified byte length, Base64URL-encoded, and the specified expiration date.

Parameters:

byteLength - The byte length of the secret value to generate. Must be greater than one.

expDate - The expiration date, null if not specified.

Secret

public Secret()

Creates a new secret with a randomly generated 256-bit (32-byte) value, Base64URL-encoded.

Method Detail

getValue

public String getValue()

Gets the value of this secret.

Returns:

The value as a UTF-8 encoded string, null if it has been erased.

getValueBytes

public byte[] getValueBytes()

Gets the value of this secret.

Returns:

The value as a byte array, null if it has been erased.

erase

public void erase()

Erases of the value of this secret.

getExpirationDate

public Date getExpirationDate()

Gets the expiration date of this secret.

Returns:

The expiration date, null if not specified.

expired

public boolean expired()

Checks is this secret has expired.

Returns:

true if the secret has an associated expiration date which is in the past (according to the current system time), else returns false.

equals

public boolean equals(Object object)

Overrides Object.equals().

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

Returns:

true if the objects are secrets the same value, otherwise false.