Package org.forgerock.secrets

Class NoSuchSecretException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.forgerock.secrets.NoSuchSecretException

All Implemented Interfaces:

Serializable

public class NoSuchSecretException
extends Exception

Indicates that no secret was configured for the given purpose, or the named secret is not available.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NoSuchSecretException(String id)	Constructs the exception for the given secret stable id.
NoSuchSecretException(String message, Throwable cause)	Constructs a new exception with the specified detail message and cause.
NoSuchSecretException(Purpose<?> purpose)	Constructs the exception for the given purpose.
NoSuchSecretException(Purpose<?> purpose, String id)	Constructs the exception for the given purpose and secret stable id.

Method Summary

Modifier and Type	Method	Description
Purpose<?>	getPurpose()	Returns the purpose for which no secret was found, or null if not specified.
String	getSecretId()	Returns the stable id of the secret that was not found, or null if not specified.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NoSuchSecretException

public NoSuchSecretException(Purpose<?> purpose,
                             String id)

Constructs the exception for the given purpose and secret stable id.

Parameters:

purpose - the purpose.

id - the stable id of the secret that was not found.

NoSuchSecretException

public NoSuchSecretException(Purpose<?> purpose)

Constructs the exception for the given purpose.

Parameters:

purpose - the purpose.

NoSuchSecretException

public NoSuchSecretException(String id)

Constructs the exception for the given secret stable id.

Parameters:

id - the stable id of the secret that was not found.

NoSuchSecretException

public NoSuchSecretException(String message,
                             Throwable cause)

Constructs a new exception with the specified detail message and cause. Note that this does not capture the secretId or purpose.

Parameters:

message - the detail message

cause - the cause

Method Detail

getPurpose

public Purpose<?> getPurpose()

Returns the purpose for which no secret was found, or null if not specified.

Returns:

the purpose for which no secret was found.

getSecretId

public String getSecretId()

Returns the stable id of the secret that was not found, or null if not specified.

Returns:

the stable if of the secret that was not found, or null if not specified.