com.ibm.portal.resolver.exceptions
Class ResolutionException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.portal.resolver.exceptions.ResolutionException

All Implemented Interfaces:

Localized, LocalizedStatus, Constants, java.io.Serializable

Direct Known Subclasses:

AccessControlFailedException, EntityNotFoundException, InvalidParameterException, MessageCodeResolutionException, RedirectResolutionException, ResolutionProxyException, ResolutionSerializationException, ResolutionTimeoutException

public abstract class ResolutionException
extends java.lang.Exception
implements LocalizedStatus, Constants

Baseclass for the exceptions that can occur during the resolution process

Since:

7.0

See Also:

Serialized Form

Note:

This interface is designed to be implemented by clients.

Field Summary

Fields inherited from interface com.ibm.portal.resolver.exceptions.Constants

SC_BAD_REQUEST, SC_GONE, SC_INTERNAL_SERVER_ERROR, SC_NOT_FOUND, SC_REQUEST_TIMEOUT, SC_SERVICE_UNAVAILABLE, SC_UNAUTHORIZED

Constructor Summary

protected	ResolutionException() Default exception without a cause
protected	ResolutionException(java.lang.Throwable th) Exception that contains a root cause

Method Summary

static Localized	findLocalized(java.lang.Throwable ex) Finds an implementation of the Localized interface across the chain of exception causes
static LocalizedStatus	findLocalizedStatus(int defaultStatus, java.lang.Throwable ex) Find the localized status interface across the causes
java.lang.String	getDescription(java.util.Locale aLocale) Returns the description of this object in the given locale.
ListModel<java.util.Locale>	getLocales() Returns a list model containing the locales that are supported by this object.
static Localized	getLocalized() Returns the empty singleton in case no base is available
static Localized	getLocalized(java.lang.Throwable ex) Converts any exception into a localized object
java.lang.String	getLocalizedMessage()
static LocalizedStatus	getLocalizedStatus(Localized ex, int aStatus)
java.lang.String	getMessage()
int	getStatus() Returns as a hint to the client the recommended HTTP status code.
protected java.lang.String	getTitle(com.ibm.wps.util.MessageCode code, java.lang.Object[] obj, java.util.Locale loc)

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.portal.Localized

getTitle

Constructor Detail

ResolutionException

protected ResolutionException()

Default exception without a cause

ResolutionException

protected ResolutionException(java.lang.Throwable th)

Exception that contains a root cause

Parameters:

th - root cause of the exception

Method Detail

findLocalized

public static Localized findLocalized(java.lang.Throwable ex)

Finds an implementation of the Localized interface across the chain of exception causes

Parameters:

ex - the exception

Returns:

the localized object

findLocalizedStatus

public static LocalizedStatus findLocalizedStatus(int defaultStatus,
                                                  java.lang.Throwable ex)

Find the localized status interface across the causes

Parameters:

defaultStatus -

ex -

Returns:

getLocalized

public static Localized getLocalized()

Returns the empty singleton in case no base is available

Returns:

the localized

getLocalized

public static Localized getLocalized(java.lang.Throwable ex)

Converts any exception into a localized object

Parameters:

ex - original exception

Returns:

localized object, potentially a proxy

getLocalizedStatus

public static LocalizedStatus getLocalizedStatus(Localized ex,
                                                 int aStatus)

getDescription

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

Description copied from interface: Localized

Returns the description of this object in the given 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()

Description copied from interface: Localized

Returns a list model containing the locales that are supported by this object. The presence of a locale in this list does not mean that a title and description is available, but rather that either one or both are available in that locale.

Specified by:

getLocales in interface Localized

Returns:

a list of locales defined for this object, returns an empty ListModel if no locales are supported.

getLocalizedMessage

public java.lang.String getLocalizedMessage()

Overrides:

getLocalizedMessage in class java.lang.Throwable

getMessage

public java.lang.String getMessage()

Overrides:

getMessage in class java.lang.Throwable

getStatus

public int getStatus()

Returns as a hint to the client the recommended HTTP status code. Subclasses of this exception are advised to override this method to provide for more refined error codes.

Specified by:

getStatus in interface LocalizedStatus

Returns:

HTTP status code

getTitle

protected java.lang.String getTitle(com.ibm.wps.util.MessageCode code,
                                    java.lang.Object[] obj,
                                    java.util.Locale loc)