Package oracle.security.am.plugin.authn

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

oracle.security.am.plugin.authn.AuthenticationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExtAuthenticationException

public class AuthenticationException
extends RuntimeException

Since:

OAM 11.1.1.2.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationException()	Create Exception.
AuthenticationException<wbr>(String key)	Create Exception.
AuthenticationException<wbr>(String messageId, Object[] params)	Constructs a new exception with the specified message ID and parameters.
AuthenticationException<wbr>(String key, Throwable t)	Create Exception.
AuthenticationException<wbr>(String messageId, Throwable cause, Object[] params)	Constructs a new exception with passed message ID, cause, and parameters.
AuthenticationException<wbr>(String key, AuthenticationErrorCode errorCode)	Instantiates a new authentication exception.
AuthenticationException<wbr>(String key, AuthenticationErrorCode errorCode, Throwable t)	Instantiates a new authentication exception.
AuthenticationException<wbr>(Throwable t)	Create Exception.
AuthenticationException<wbr>(AuthenticationErrorCode errorCode)	Instantiates a new authentication exception.
AuthenticationException<wbr>(AuthenticationErrorCode errorCode, String secondaryErrorMessage)	Instantiates a new authentication exception.
AuthenticationException<wbr>(AuthenticationErrorCode errorCode, Throwable t)	Instantiates a new authentication exception.
AuthenticationException<wbr>(AuthenticationErrorCode errorCode, Throwable t, String secondaryErrorMessage)	Instantiates a new authentication exception.
AuthenticationException<wbr>(PluginAuthenticationErrorCode pluginErrorCode)	Instantiates a new authentication exception.
AuthenticationException<wbr>(PluginAuthenticationErrorCode pluginErrorCode, String secondaryErrorMessage)	Instantiates a new authentication exception.
AuthenticationException<wbr>(PluginAuthenticationErrorCode pluginErrorCode, Throwable t, String secondaryErrorMessage)	Instantiates a new authentication exception.

Method Summary

Modifier and Type	Method	Description
AuthenticationErrorCode	getErrorCode()	Gets the error code.
String	getMessage()	Returns the detail message string associated with the message ID for the current locale.
String	getMessage<wbr>(Locale locale)	Returns the detail message string associated with the message ID for the requested locale, if available.
String	getMessageId()	Returns the message ID that was passed in on creation, if any.
PluginAuthenticationErrorCode	getPluginAuthenticationErrorCode()
String	getSecondaryErrorMessage()	Returns the secondary Error message.
String	toString()	In addition, the message ID is included as a separate field from the message itself if those are distinct.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AuthenticationException

public AuthenticationException()

Create Exception.

AuthenticationException

public AuthenticationException<wbr>(AuthenticationErrorCode errorCode)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code

AuthenticationException

public AuthenticationException<wbr>(PluginAuthenticationErrorCode pluginErrorCode)

Instantiates a new authentication exception.

Parameters:

pluginErrorCode - the plugin error code

AuthenticationException

public AuthenticationException<wbr>(AuthenticationErrorCode errorCode,
 String secondaryErrorMessage)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code

secondaryErrorMessage - Secondary error message

AuthenticationException

public AuthenticationException<wbr>(PluginAuthenticationErrorCode pluginErrorCode,
 String secondaryErrorMessage)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code

secondaryErrorMessage - Secondary error message

AuthenticationException

public AuthenticationException<wbr>(String key)

Create Exception.

Parameters:

key - the key

AuthenticationException

public AuthenticationException<wbr>(String key,
 AuthenticationErrorCode errorCode)

Instantiates a new authentication exception.

Parameters:

key - the key

errorCode - the error code

AuthenticationException

public AuthenticationException<wbr>(String key,
 Throwable t)

Create Exception.

Parameters:

key - the key

t - the t

AuthenticationException

public AuthenticationException<wbr>(String key,
 AuthenticationErrorCode errorCode,
 Throwable t)

Instantiates a new authentication exception.

Parameters:

key - the key

errorCode - the error code

t - the t

AuthenticationException

public AuthenticationException<wbr>(Throwable t)

Create Exception.

Parameters:

t - the t

AuthenticationException

public AuthenticationException<wbr>(AuthenticationErrorCode errorCode,
 Throwable t)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code

t - the t

AuthenticationException

public AuthenticationException<wbr>(AuthenticationErrorCode errorCode,
 Throwable t,
 String secondaryErrorMessage)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code

t - the t

secondaryErrorMessage - Secondary error message

AuthenticationException

public AuthenticationException<wbr>(PluginAuthenticationErrorCode pluginErrorCode,
 Throwable t,
 String secondaryErrorMessage)

Instantiates a new authentication exception.

Parameters:

errorCode - the plugin error code

t - the t

secondaryErrorMessage - Secondary error message

AuthenticationException

public AuthenticationException<wbr>(String messageId,
 Object[] params)

Constructs a new exception with the specified message ID and parameters.

Parameters:

messageId -

params -

AuthenticationException

public AuthenticationException<wbr>(String messageId,
 Throwable cause,
 Object[] params)

Constructs a new exception with passed message ID, cause, and parameters.

Parameters:

messageId -

cause -

params -

Method Details

getErrorCode

public AuthenticationErrorCode getErrorCode()

Gets the error code.

Returns:

the error code

getMessageId

public String getMessageId()

Returns the message ID that was passed in on creation, if any.

Returns:

getMessage

public String getMessage()

Returns the detail message string associated with the message ID for the current locale. If not found, the message ID itself is returned.

Overrides:

getMessage in class Throwable

getSecondaryErrorMessage

public String getSecondaryErrorMessage()

Returns the secondary Error message.

Returns:

getMessage

public String getMessage<wbr>(Locale locale)

Returns the detail message string associated with the message ID for the requested locale, if available. If not found, the message ID itself is returned, or null if unset.

toString

public String toString()

In addition, the message ID is included as a separate field from the message itself if those are distinct.

Overrides:

toString in class Throwable

getPluginAuthenticationErrorCode

public PluginAuthenticationErrorCode getPluginAuthenticationErrorCode()