com.appiancorp.suiteapi.common.exceptions

Class AppianException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActionNotFoundException, AppianException, ApplicationNotFoundException, Controller.ControllerException, DuplicateExpressionException, DuplicateIdException, DuplicateNameException, DuplicateUuidException, InvalidActionException, InvalidActivityClassSchemaException, InvalidApplicationException, InvalidCalendarException, InvalidDecimalException, InvalidNavigationItemException, InvalidStatusException, LocalizedAppianRuntimeException.LocalizedAppianException, ObjectNotFoundException, RenameNotAllowedException, ResultPageSizeException, RetryableAppianException, SelfRenameException, ServiceLocatorException, SmartServiceException, UnavailableApplicationException, UpgradeException

public class AppianException
extends java.lang.Exception

AppianException is the base class of all application-level exceptions thrown in the product. Application-level exceptions are intended to be caught and handled locally by one of the callers that is capable of taking the appropriate action (such as retrying, performing alternative operations, notifying the user, showing a local message on the user interface, etc.) AppianException takes care of properly formatting and internationalizing the exception messages by associating the exception with an error code. Subclasses should override the getErrorCode and getErrorCodeArguments methods to map the appropriate message to the exception.

See Also:

AppianRuntimeException, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AppianException() Deprecated.
AppianException(ErrorCode errorCode, java.lang.Object... errorCodeArgs)
AppianException(ErrorCode errorCode, java.lang.Throwable cause)
AppianException(ErrorCode errorCode, java.lang.Throwable cause, java.lang.Object... errorCodeArgs)
AppianException(java.lang.String message) Deprecated. this constructor will be removed in future releases, as all exception messages must be associated via an error code.
AppianException(java.lang.String message, java.lang.Throwable cause) Deprecated. this constructor will be removed in future releases, as all exception messages must be associated via an error code.
AppianException(java.lang.Throwable cause) Constructs a new AppianException as a wrapper around the Throwable passed in with a detail message of (cause==null ?

Method Summary

Modifier and Type	Method and Description
ErrorCode	getErrorCode() Gets the error code associated with this exception.
protected java.lang.Object[]	getErrorCodeArguments() Gets the arguments that must be used to render this exception's message representation.
protected java.lang.Object[]	getErrorCodeArguments(java.util.Locale locale) Gets the arguments that must be used to render this exception's message and title representation.
java.lang.String[]	getErrorCodeArgumentsAsStringArray(java.util.Locale locale) Returns the arguments (converted to Strings) of the error code tied to this exception.
java.lang.String	getLocalizedMessage() The default implementation is equivalent to calling getLocalizedMessage(Locale) with Locale.US as argument.
java.lang.String	getLocalizedMessage(java.util.Locale locale) Returns this exception's message representation.
java.lang.String	getLocalizedMessageWithErrorCode(java.util.Locale locale) Returns this exception's default message representation with error code information.
java.lang.String	getLocalizedTitle(java.util.Locale locale) Returns this exception's title representation.
java.lang.String	getMessage() The default implementation is equivalent to calling getLocalizedMessage()
java.lang.String	toString() Returns a detailed exception's message representation.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AppianException

public AppianException(ErrorCode errorCode,
                       java.lang.Throwable cause)

AppianException

public AppianException(ErrorCode errorCode,
                       java.lang.Object... errorCodeArgs)

AppianException

public AppianException(ErrorCode errorCode,
                       java.lang.Throwable cause,
                       java.lang.Object... errorCodeArgs)

AppianException

@Deprecated
public AppianException()

Deprecated.

Constructs a new AppianException with an empty string as its detail message.

AppianException

@Deprecated
public AppianException(java.lang.String message)

Deprecated. this constructor will be removed in future releases, as all exception messages must be associated via an error code.

AppianException

public AppianException(java.lang.Throwable cause)

Constructs a new AppianException as a wrapper around the Throwable passed in with a detail message of (cause==null ? "" : cause.toString()).

Parameters:

cause - the cause, or the Throwable that caused this AppianException to get thrown

AppianException

@Deprecated
public AppianException(java.lang.String message,
                                   java.lang.Throwable cause)

Deprecated. this constructor will be removed in future releases, as all exception messages must be associated via an error code.

Method Detail

getErrorCode

public ErrorCode getErrorCode()

Gets the error code associated with this exception. Subclasses should override this method to return specific error codes. The default implementation returns APNX-1-0000-000 (ErrorCode.GENERIC_ERROR).

See Also:

ErrorCode.GENERIC_ERROR

getErrorCodeArguments

protected java.lang.Object[] getErrorCodeArguments()

Gets the arguments that must be used to render this exception's message representation. Subclasses should override this method to return specific arguments. The default implementation returns a length 1 array containing the message as returned by the parent class of AppianException. This method is only called when getErrorCodeArguments(Locale) hasn't been overwritten.

Returns:

the arguments of the error code tied to this exception

See Also:

ErrorCode.GENERIC_ERROR

getErrorCodeArgumentsAsStringArray

public final java.lang.String[] getErrorCodeArgumentsAsStringArray(java.util.Locale locale)

Returns the arguments (converted to Strings) of the error code tied to this exception. Returns an empty array if there are no arguments.

Parameters:

locale - The locale to use for retrieving the arguments.

getErrorCodeArguments

protected java.lang.Object[] getErrorCodeArguments(java.util.Locale locale)

Gets the arguments that must be used to render this exception's message and title representation. Subclasses should override this method to return specific locale-sensitive arguments. The default implementation calls getErrorCodeArguments().

Parameters:

locale - arguments' locale

Returns:

the arguments of the error code tied to this exception

getMessage

public java.lang.String getMessage()

The default implementation is equivalent to calling getLocalizedMessage()

Overrides:

getMessage in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage()

The default implementation is equivalent to calling getLocalizedMessage(Locale) with Locale.US as argument.

Overrides:

getLocalizedMessage in class java.lang.Throwable

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale locale)

Returns this exception's message representation. This method should be used whenever the message is to be displayed to the end user. The default representation does not include any error code information because this may be rendered in different ways across the application. If needed, the exception's error code can be retrieved from getErrorCode().

Parameters:

locale - message's locale

Returns:

this exception's message representation

See Also:

toString()

getLocalizedTitle

public java.lang.String getLocalizedTitle(java.util.Locale locale)

Returns this exception's title representation. This method should be used whenever the title is to be displayed to the end user. The default representation does not include any error code information because this may be rendered in different ways across the application. If needed, the exception's error code can be retrieved from getErrorCode().

Parameters:

locale - title's locale

Returns:

this exception's title representation

See Also:

toString()

getLocalizedMessageWithErrorCode

public java.lang.String getLocalizedMessageWithErrorCode(java.util.Locale locale)

Returns this exception's default message representation with error code information. This method could be used whenever the message is to be displayed to the end user. Although the default representation getLocalizedMessage(Locale) does not include any error code information, as the representation could vary in different ways across the application, this method provides a utility for a representation with error code. If the error code is null or ErrorCode.GENERIC_ERROR, no error code information is included. Be sure while using this method as the requirements could vary, in which case use getLocalizedMessage(Locale) in conjunction with getErrorCode().

Parameters:

locale - message's locale

Returns:

this exception's default message representation with error code

See Also:

getLocalizedMessage(Locale), toString()

toString

public java.lang.String toString()

Returns a detailed exception's message representation. This method should not be used to display messages to the end user. The default representation includes the exception class name, the exception's message as returned by getMessage() and the error code associated with this exception. If the error code is ErrorCode.GENERIC_ERROR, no error code information is included.

Overrides:

toString in class java.lang.Throwable