Package oracle.security.xs

Class XSException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.security.xs.XSException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AccessDeniedException, InvalidSessionException, InvalidXSAttributeException, InvalidXSNamespaceException, InvalidXSUserException, NotAttachedException, SessionNamespaceException, XSPrincipalException, XSSessionException, XSSessionManagerException

public class XSException
extends java.lang.Exception

Base exception class and a wrapper for server-side error. Exception thrown when an error occurs in most of the APIs. For example, this exception is thrown when an invalid or null parameter is passed to the Session API or an error from the server round-trip operations occurs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XSException()	Creates a new XSException.
XSException(java.lang.String message)	Creates a new XSException with the specified exception message.
XSException(java.lang.String errKey, java.lang.Object[] parameters)	Creates a new XSException with the specified error key and parameters.
XSException(java.lang.String errKey, java.lang.Object[] parameters, java.lang.Throwable cause)	Creates a new XSException with the specified error key, parameters, and cause of error.
XSException(java.lang.String message, java.lang.Throwable cause)	Creates a new XSException with the specified exception message and cause of exception.
XSException(java.lang.Throwable cause)	Creates a new XSException with the specified cause of the exception.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getMessage()	Returns the detailed message of the exception.
java.lang.String	getMessage(java.util.Locale lc)	Returns the detailed message of the exception in the specified Locale.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XSException

public XSException()

Creates a new XSException.

XSException

public XSException(java.lang.String message)

Creates a new XSException with the specified exception message.

Parameters:

message - the exception message

XSException

public XSException(java.lang.Throwable cause)

Creates a new XSException with the specified cause of the exception.

Parameters:

cause - the cause of the exception

XSException

public XSException(java.lang.String message,
                   java.lang.Throwable cause)

Creates a new XSException with the specified exception message and cause of exception.

Parameters:

message - the exception message

cause - the cause of the exception

XSException

public XSException(java.lang.String errKey,
                   java.lang.Object[] parameters,
                   java.lang.Throwable cause)

Creates a new XSException with the specified error key, parameters, and cause of error.

Parameters:

errKey - the error key

parameters - the parameters

cause - the cause of the error

XSException

public XSException(java.lang.String errKey,
                   java.lang.Object[] parameters)

Creates a new XSException with the specified error key and parameters.

Parameters:

errKey - the error key

parameters - the parameters

Method Detail

getMessage

public java.lang.String getMessage()

Returns the detailed message of the exception.

Overrides:

getMessage in class java.lang.Throwable

Returns:

the detail message string of this exception instance

getMessage

public java.lang.String getMessage(java.util.Locale lc)

Returns the detailed message of the exception in the specified Locale.

Parameters:

lc - Locale

Returns:

the detail message string of this exception instance in the specified Locale