oracle.adf.share.security

Class ADFSecurityException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.adf.share.security.ADFSecurityException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AppPolicyServiceNotSupportedException, CredentialNotFoundException

public class ADFSecurityException
extends java.lang.Exception

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ADFSecurityException() Construct ADFSecurityException with default error message lookup key.
ADFSecurityException(java.lang.String msgKey) Construct ADFSecurityException with the given error message lookup key.
ADFSecurityException(java.lang.String msgKey, java.lang.Object[] msgArgs) Constructs the ADFSecurityException with the given error message lookup key and message substitution arguments that are used for message formatting.
ADFSecurityException(java.lang.String msgKey, java.util.ResourceBundle resourceBundle) Constructs the ADFSecurityException with the given error message lookup key and the look up resource bundle.
ADFSecurityException(java.lang.Throwable cause) Construct the ADFSecurityException with default error message lookup key and with the given Throwablecause.
ADFSecurityException(java.lang.Throwable cause, java.lang.String msgKey, java.lang.Object[] msgArgs) Constructs the ADFSecurityException with the given error Throwable cause, message lookup key and message substitution arguments that are used for message formatting.
ADFSecurityException(java.lang.Throwable cause, java.lang.String msgKey, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3) Construct ADFSecurityException with the given Throwable cause, error message lookup key and message substitution arguments that are used for message formatting.
ADFSecurityException(java.lang.Throwable cause, java.lang.String msgKey, java.util.ResourceBundle resourceBundle, java.lang.Object[] msgArgs) Constructs the ADFSecurityException with the given error Throwable cause, message lookup key, overriding resource bundle and message substitution arguments that are used for message formatting.
ADFSecurityException(java.lang.Throwable cause, java.lang.String msgKey, java.util.ResourceBundle resourceBundle, java.lang.Object obj1, java.lang.Object obj2, java.lang.Object obj3) Construct ADFSecurityException with the given Throwable cause, error message lookup key, overriding resource bundle and message substitution arguments that are used for message formatting.

Method Summary

Modifier and Type	Method and Description
java.lang.Throwable	getCause()
java.lang.String	getErrorMessage() Returns the error message determined by the following rules If the "message key" is default and there no "cause" exception, returns the default message corresponding to the "default message key".
java.lang.String	getErrorMsgKey() Returns the error message key.
java.lang.String	getLocalErrorMessage() Get the local message for this ADFSecurityException.
java.lang.String	getLocalizedMessage()
static void	init() Initialize the ADFSecurityException with the base name of the resource bundle, a fully qualified class name.
void	printErrorMessage() Prints the error message in the System's default output PrintStream returned by System.out.
void	printStackTrace()
void	printStackTrace(java.io.PrintStream stream)
void	printStackTrace(java.io.PrintWriter writer)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ADFSecurityException

public ADFSecurityException()

Construct ADFSecurityException with default error message lookup key.

ADFSecurityException

public ADFSecurityException(java.lang.String msgKey)

Construct ADFSecurityException with the given error message lookup key.

Parameters:

msgKey - the error message lookup key

ADFSecurityException

public ADFSecurityException(java.lang.String msgKey,
                            java.lang.Object[] msgArgs)

Constructs the ADFSecurityException with the given error message lookup key and message substitution arguments that are used for message formatting.

Parameters:

msgKey - the error message lookup key

msgArgs - Object array for the message formatting

ADFSecurityException

public ADFSecurityException(java.lang.String msgKey,
                            java.util.ResourceBundle resourceBundle)

Constructs the ADFSecurityException with the given error message lookup key and the look up resource bundle. This resource bundle will override default resource bundle for lookup.

Parameters:

msgKey - the error message lookup key

resourceBundle - The resource bundle

ADFSecurityException

public ADFSecurityException(java.lang.Throwable cause)

Construct the ADFSecurityException with default error message lookup key and with the given Throwablecause.

Parameters:

cause - parent exception that caused this one.

ADFSecurityException

public ADFSecurityException(java.lang.Throwable cause,
                            java.lang.String msgKey,
                            java.lang.Object obj1,
                            java.lang.Object obj2,
                            java.lang.Object obj3)

Construct ADFSecurityException with the given Throwable cause, error message lookup key and message substitution arguments that are used for message formatting. Convenience constructor so that obj array need not be created in common cases.

Parameters:

cause - parent exception that caused it

msgKey - the error message lookup key

obj1 - substitution argument used to create the object array, which is used for message formatting.

obj2 - substitution argument used to create the object array, which is used for message formatting.

obj3 - substitution argument used to create the object array, which is used for message formatting.

ADFSecurityException

public ADFSecurityException(java.lang.Throwable cause,
                            java.lang.String msgKey,
                            java.util.ResourceBundle resourceBundle,
                            java.lang.Object obj1,
                            java.lang.Object obj2,
                            java.lang.Object obj3)

Construct ADFSecurityException with the given Throwable cause, error message lookup key, overriding resource bundle and message substitution arguments that are used for message formatting. Convenience constructor so that obj array need not be created in common cases.

Parameters:

cause - parent exception that caused it

msgKey - the error message lookup key

resourceBundle - the resource bundle

obj1 - substitution argument used to create the object array, which is used for message formatting.

obj2 - substitution argument used to create the object array, which is used for message formatting.

obj3 - substitution argument used to create the object array, which is used for message formatting.

ADFSecurityException

public ADFSecurityException(java.lang.Throwable cause,
                            java.lang.String msgKey,
                            java.lang.Object[] msgArgs)

Constructs the ADFSecurityException with the given error Throwable cause, message lookup key and message substitution arguments that are used for message formatting.

Parameters:

cause - parent exception that caused it

msgKey - the error message lookup key

msgArgs - Object array for the messageFormatting

ADFSecurityException

public ADFSecurityException(java.lang.Throwable cause,
                            java.lang.String msgKey,
                            java.util.ResourceBundle resourceBundle,
                            java.lang.Object[] msgArgs)

Constructs the ADFSecurityException with the given error Throwable cause, message lookup key, overriding resource bundle and message substitution arguments that are used for message formatting.

Parameters:

cause - parent exception that caused it

msgKey - the error message lookup key

resourceBundle - The resource bundle

msgArgs - Object array for the messageFormatting

Method Detail

init

public static void init()
                 throws java.util.MissingResourceException

Initialize the ADFSecurityException with the base name of the resource bundle, a fully qualified class name.

Throws:

java.util.MissingResourceException - if no resource bundle for the specified base name can be found.

getErrorMsgKey

public java.lang.String getErrorMsgKey()

Returns the error message key.

Returns:

String - error message key.

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message determined by the following rules

1. If the "message key" is default and there no "cause" exception, returns the default message corresponding to the "default message key".
   ex: new ADFSecurityException()
2. If the "message key" is default and there is a "cause" exception, returns ONLY the message from the cause exception. ex: new ADFSecurityException(causeEx)
   
3. If "message key" is non-default and there is no "cause" exception, returns the message corresponding to the "message key".
   ex: new ADFSecurityException(null, "<MSG_KEY>")
4. If "message key" is non-default and there is a "cause" exception, returns the message corresponding to the "message key" and the message from the cause exception.
   ex: new ADFSecurityException(causeEx, "<MSG_KEY>")

Returns:

String - the error message.

getLocalErrorMessage

public java.lang.String getLocalErrorMessage()

Get the local message for this ADFSecurityException. Unlike the getErrorMessage() method, 1. this method does not return the error message of the cause exception. 2. it also does not recursively return the error messages of the chained exception.

Returns:

The local message for this ADFSecurityException. "" if there is no error message key defined for this ADFSecurityException

printErrorMessage

public void printErrorMessage()

Prints the error message in the System's default output PrintStream returned by System.out.

printStackTrace

public void printStackTrace()

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintStream stream)

Overrides:

printStackTrace in class java.lang.Throwable

printStackTrace

public void printStackTrace(java.io.PrintWriter writer)

Overrides:

printStackTrace in class java.lang.Throwable

getCause

public java.lang.Throwable getCause()

Overrides:

getCause in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable