com.appiancorp.suiteapi.process.exceptions

Class RetryableSmartServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.suiteapi.process.exceptions.SmartServiceException

com.appiancorp.suiteapi.process.exceptions.RetryableSmartServiceException

All Implemented Interfaces:

Retryable, java.io.Serializable

public class RetryableSmartServiceException
extends SmartServiceException
implements Retryable

A subclass of SmartServiceException that indicates that the exception is transient and the smart service can be safely retried.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RetryableSmartServiceException.Builder The Builder inner class is used to create an instance of the SmartServiceException.

Field Summary

Fields inherited from class com.appiancorp.suiteapi.process.exceptions.SmartServiceException

addCauseToAlertMessageArgs, addCauseToUserMessageArgs, alertMessageArgs, alertMessageKey, userMessageArgs, userMessageKey

Constructor Summary

Constructors

Constructor and Description
RetryableSmartServiceException(java.lang.Class<? extends AppianSmartService> smartServiceClass, java.lang.Throwable cause, java.lang.String key, java.lang.Object... args) Construct a RetryableSmartServiceException from all of its constituent parts.
RetryableSmartServiceException(ErrorCode errorCode, java.lang.Object... errorCodeArgs) Constructor to be used if the RetryableSmartServiceException has an error code associated with it.
RetryableSmartServiceException(ErrorCode errorCode, java.lang.Throwable cause) Constructor to be used if the RetryableSmartServiceException has an error code associated with it and the root cause of the exception is to be included.
RetryableSmartServiceException(ErrorCode errorCode, java.lang.Throwable cause, java.lang.Object... errorCodeArgs) Constructor to be used if the RetryableSmartServiceException has an error code associated with it and the root cause of the exception is to be included.

Method Summary

Methods inherited from class com.appiancorp.suiteapi.process.exceptions.SmartServiceException

getAlertMessage, getAttendedUserMessage, getCauseMessage, getExceptionClassName, getMessageFromBundle, toString

Methods inherited from class com.appiancorp.suiteapi.common.exceptions.AppianException

getErrorCode, getErrorCodeArguments, getErrorCodeArguments, getErrorCodeArgumentsAsStringArray, getLocalizedMessage, getLocalizedMessage, getLocalizedMessageWithErrorCode, getLocalizedTitle, getMessage

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

RetryableSmartServiceException

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

Constructor to be used if the RetryableSmartServiceException has an error code associated with it.

Parameters:

errorCode - the error code associated with the exception

errorCodeArg - the parameters to the error code message

See Also:

ErrorCode

RetryableSmartServiceException

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

Constructor to be used if the RetryableSmartServiceException has an error code associated with it and the root cause of the exception is to be included.

Parameters:

errorCode - the error code associated with the exception

cause - the cause of the exception

errorCodeArg - the parameters to the error code message

See Also:

ErrorCode

RetryableSmartServiceException

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

Constructor to be used if the RetryableSmartServiceException has an error code associated with it and the root cause of the exception is to be included.

Parameters:

errorCode - the error code associated with the exception

cause - the cause of the exception

See Also:

ErrorCode

RetryableSmartServiceException

public RetryableSmartServiceException(java.lang.Class<? extends AppianSmartService> smartServiceClass,
                                      java.lang.Throwable cause,
                                      java.lang.String key,
                                      java.lang.Object... args)

Construct a RetryableSmartServiceException from all of its constituent parts. It's recommended to use the Builder inner class instead of this constructor.

Parameters:

smartServiceClass - the class that is throwing the exception

cause - the Throwable that was caught, causing the SmartServiceException to be thrown

key - the key to the error message in the bundle

args - the set of paramaters that are passed with the error message to include dynamic information in the message if the value of the error bundle contains templates.