Skip navigation links

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:

java.io.Serializable

public class AuthenticationException

extends java.lang.RuntimeException

Basic authentication Exception that needs to be thrown from AUthentication plugins.

Since:

OAM 11.1.1.5.0

Version:

OAM 11.1.1.5.0

See Also:

Serialized Form

Constructor Summary

AuthenticationException()
Default constructor.

AuthenticationException(AuthenticationErrorCode errorCode)
Instantiates a new authentication exception.

AuthenticationException(AuthenticationErrorCode errorCode, java.lang.Throwable t)
Instantiates a new authentication exception.

AuthenticationException(java.lang.String key)
Instantiates an authentication exception using a message key.

AuthenticationException(java.lang.String key, AuthenticationErrorCode errorCode)
Instantiates a new authentication exception.

AuthenticationException(java.lang.String key, AuthenticationErrorCode errorCode, java.lang.Throwable t)
Instantiates a new authentication exception.

AuthenticationException(java.lang.String messageId, java.lang.Object[] params)
Constructs a new exception with the specified message ID and parameters.

AuthenticationException(java.lang.String key, java.lang.Throwable t)
Create Exception.

AuthenticationException(java.lang.String messageId, java.lang.Throwable cause, java.lang.Object[] params)
Constructs a new exception with passed message ID, cause, and parameters.

AuthenticationException(java.lang.Throwable t)
Instantiates a new authentication exception.

Method Summary

AuthenticationErrorCode	getErrorCode() Gets the error code.
java.lang.String	getMessage() Returns the detail message string associated with the message ID for the current locale.
java.lang.String	getMessage(java.util.Locale locale) Returns the detail message string associated with the message ID for the requested locale, if available.
java.lang.String	getMessageId() Returns the message ID that was passed in on creation, if any.
java.lang.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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationException

public AuthenticationException()

Default constructor. Create Exception.

AuthenticationException

public AuthenticationException(AuthenticationErrorCode errorCode)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code AuthenticationErrorCode object.

AuthenticationException

public AuthenticationException(java.lang.String key)

Instantiates an authentication exception using a message key.

Parameters:

key - the key

AuthenticationException

public AuthenticationException(java.lang.String key,
                               AuthenticationErrorCode errorCode)

Instantiates a new authentication exception. with message key and error code.

Parameters:

key - the key

errorCode - the error code

AuthenticationException

public AuthenticationException(java.lang.String key,
                               java.lang.Throwable t)

Create Exception. with key and a object of type Throwable

Parameters:

key - the key

t - the t

AuthenticationException

public AuthenticationException(java.lang.String key,
                               AuthenticationErrorCode errorCode,
                               java.lang.Throwable t)

Instantiates a new authentication exception. with key errocode and a Throwable object.

Parameters:

key - the key

errorCode - the error code

t - the Throwable

AuthenticationException

public AuthenticationException(java.lang.Throwable t)

Instantiates a new authentication exception. with a Throwable object.

Parameters:

t - the Throwable

AuthenticationException

public AuthenticationException(AuthenticationErrorCode errorCode,
                               java.lang.Throwable t)

Instantiates a new authentication exception.

Parameters:

errorCode - the error code

t - the t

AuthenticationException

public AuthenticationException(java.lang.String messageId,
                               java.lang.Object[] params)

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

Parameters:

messageId -

params -

AuthenticationException

public AuthenticationException(java.lang.String messageId,
                               java.lang.Throwable cause,
                               java.lang.Object[] params)

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

Parameters:

messageId -

cause -

params -

Method Detail

getErrorCode

public AuthenticationErrorCode getErrorCode()

Gets the error code.

Returns:

the error code

getMessageId

public java.lang.String getMessageId()

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

Returns:

getMessage

public java.lang.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 java.lang.Throwable

getMessage

public java.lang.String getMessage(java.util.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 java.lang.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 java.lang.Throwable

Skip navigation links