com.appiancorp.suiteapi.applications

Class UnavailableApplicationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.appiancorp.suiteapi.common.exceptions.AppianException

com.appiancorp.suiteapi.applications.UnavailableApplicationException

All Implemented Interfaces:

java.io.Serializable

public class UnavailableApplicationException
extends AppianException

When updating an application, we will try to lock the object before making any updates in order to avoid race conditions. This exception will be thrown if we fail to get the lock after a couple of retries. These retries are defined in: resources/appian/applications/applications.properties Failure to obtain the lock shouldn't be common, this exception could be expected in heavy load scenarios with many users concurrently updating the same application. This exception could also imply a very high load on the servers where queued calls to the server are being timeout before they get to the server. Simply retrying to update the application should make the save call successful. The API already internally already waits and retries a couple of times in order to try to get the lock before giving up.

See Also:

https://wiki.appian.com/index.php/Applications_Framework_Design#Locking_an_object, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ErrorCode	errorCode
protected java.lang.Object[]	errorCodeArguments

Constructor Summary

Constructors

Constructor and Description
UnavailableApplicationException(java.lang.Long id)

Method Summary

Modifier and Type	Method and Description
ErrorCode	getErrorCode() Gets the error code associated with this exception.
java.lang.Object[]	getErrorCodeArguments() Gets the arguments that must be used to render this exception's message representation.

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

getErrorCodeArguments, getErrorCodeArgumentsAsStringArray, getLocalizedMessage, getLocalizedMessage, getLocalizedMessageWithErrorCode, getLocalizedTitle, getMessage, toString

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

Field Detail

errorCode

protected ErrorCode errorCode

errorCodeArguments

protected java.lang.Object[] errorCodeArguments

Constructor Detail

UnavailableApplicationException

public UnavailableApplicationException(java.lang.Long id)

Method Detail

getErrorCodeArguments

public java.lang.Object[] getErrorCodeArguments()

Description copied from class: AppianException

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 AppianException.getErrorCodeArguments(Locale) hasn't been overwritten.

Overrides:

getErrorCodeArguments in class AppianException

Returns:

the arguments of the error code tied to this exception

See Also:

ErrorCode.GENERIC_ERROR

getErrorCode

public ErrorCode getErrorCode()

Description copied from class: AppianException

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).

Overrides:

getErrorCode in class AppianException

See Also:

ErrorCode.GENERIC_ERROR