Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.ibm.portal.security.exceptions
Class SecurityException

    java.lang.Object
      java.lang.Throwable
          java.lang.Exception
              com.ibm.portal.security.exceptions.SecurityException

All Implemented Interfaces:
  Localized, java.io.Serializable

Direct Known Subclasses:
  ImpersonationException, LoginException, LogoutException, SessionValidationException, UserSessionTimeoutException

    public abstract class SecurityException

extends java.lang.Exception
implements Localized

Root exception class for all security related exceptions.

Since:
  6.0.1
See Also:
  Serialized Form

Constructor Summary
`protected` | `SecurityException()` Empty constructor.
`protected` | `SecurityException(MessageCode aMsgCode, java.lang.Object[] arguments)` Initializes the exception with a message code and the corresponding arguments
`protected` | `SecurityException(java.lang.Throwable cause)` Initializes the exception with the reason of the exception.

Method Summary
`java.lang.String` | `getDescription(java.util.Locale aLocale)` Return a language-specific detailed explanation of this exception.
`ListModel<java.util.Locale>` | `getLocales()` Return the languages for which language-specific exception messages and explanations are provided.
`java.lang.String` | `getTitle(java.util.Locale aLocale)` Return a language-specific exception message for this exception.

Methods inherited from class java.lang.Throwable
`fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, 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

### SecurityException

    protected SecurityException(java.lang.Throwable cause)

  Initializes the exception with the reason of the exception.

  Parameters:
    `cause` - Exception that provides details on the reason of failure (must not be null).

### SecurityException

    protected SecurityException()

  Empty constructor.

### SecurityException

    protected SecurityException(MessageCode aMsgCode,
                                java.lang.Object[] arguments)

  Initializes the exception with a message code and the corresponding arguments

  Parameters:
    `aMsgCode` - the message code
    `arguments` - the arguments

Method Detail

### getTitle

    public java.lang.String getTitle(java.util.Locale aLocale)

  Return a language-specific exception message for this exception. Returns null if no message is available for the requested locale.

  Specified by:
    `getTitle` in interface `Localized`
  Parameters:
    `aLocale` - the locale for which to retrieve the title, must not be `null`.
  Returns:
    the title of this node in the given locale. If a title is not available in the given locale, this method will return `null`. It is up to the invoker of the method to implement an appropriate fallback mechanism.

### getDescription

    public java.lang.String getDescription(java.util.Locale aLocale)

  Return a language-specific detailed explanation of this exception. Returns null if no explanation is available for the requested locale.

  Specified by:
    `getDescription` in interface `Localized`
  Parameters:
    `aLocale` - the locale for which to retrieve the description, must not be `null`.
  Returns:
    the description of this node in the given locale. If a description is not available in the given locale, this method will return `null`. It is up to the invoker of the method to implement an appropriate fallback mechanism

### getLocales

    public ListModel<java.util.Locale> getLocales()

  Return the languages for which language-specific exception messages and explanations are provided. Returns a ListModel with an empty iterator if no language-specific information is provided; never returns null.

  Specified by:
    `getLocales` in interface `Localized`
  Returns:
    a list of locales defined for this object, returns an empty `ListModel` if no locales are supported.

Overview | Package | Class | Tree | Serialized | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD