Package dev.galasa.framework.spi

Class FrameworkException

java.lang.Object

java.lang.Throwable

java.lang.Exception

dev.galasa.framework.spi.FrameworkException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthStoreException, CertificateStoreException, ConfidentialTextException, ConfigurationPropertyStoreException, CredentialsException, DynamicStatusStoreException, EventsException, FrameworkResourceUnavailableException, InternalServletException, RBACException, ResourcePoolingServiceException, ResourceUnavailableException, ResultArchiveStoreException

public class FrameworkException
extends Exception

An exception which also holds a FrameworkErrorCode to provide more fine-grained detail about the problem being raised/thrown, which is programmatically accessible. ie: Not just the error text, or instance of the exception instance. Error codes can be explicitly set when the exception is created, or will default to FrameworkErrorDetailsBase.UNKNOWN, or to the same error code from the cause (when that cause is also a FrameworkException. This allows one type of FrameworkException to wrap another, and the original cause error code will be propagated to the top-most FrameworkException in the chain.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	ENABLE_SUPRESSION_FALSE
static final boolean	WRITEABLE_STACK_TRACE_TRUE

Constructor Summary

Constructors

Constructor	Description
FrameworkException()
FrameworkException(FrameworkErrorDetails errorDetails)
FrameworkException(FrameworkErrorDetailsBase details, Throwable cause)
FrameworkException(FrameworkErrorDetails errorDetails, Throwable cause, boolean enableSuppression, boolean writableStackTrace)
FrameworkException(String message)
FrameworkException(String message, Throwable cause)	If the cause is a framework exception, then the error code from the cause is propagated into this exception instance.
FrameworkException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace)	If the cause is a framework exception, then the error code from the cause is propagated into this exception instance.
FrameworkException(Throwable cause)	If the cause is a framework exception, then the error code from the cause is propagated into this exception instance.

Method Summary

Modifier and Type	Method	Description
int	getErrorCode()
FrameworkErrorDetails	getErrorDetails()

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Field Details

ENABLE_SUPRESSION_FALSE

public static final boolean ENABLE_SUPRESSION_FALSE

See Also:

• Constant Field Values

WRITEABLE_STACK_TRACE_TRUE

public static final boolean WRITEABLE_STACK_TRACE_TRUE

See Also:

• Constant Field Values

Constructor Details

FrameworkException

public FrameworkException()

FrameworkException

public FrameworkException(FrameworkErrorDetails errorDetails)

FrameworkException

public FrameworkException(String message)

FrameworkException

public FrameworkException(Throwable cause)

If the cause is a framework exception, then the error code from the cause is propagated into this exception instance.

FrameworkException

public FrameworkException(FrameworkErrorDetailsBase details,
 Throwable cause)

FrameworkException

public FrameworkException(String message,
 Throwable cause)

If the cause is a framework exception, then the error code from the cause is propagated into this exception instance.

FrameworkException

public FrameworkException(String message,
 Throwable cause,
 boolean enableSuppression,
 boolean writableStackTrace)

If the cause is a framework exception, then the error code from the cause is propagated into this exception instance.

FrameworkException

public FrameworkException(FrameworkErrorDetails errorDetails,
 Throwable cause,
 boolean enableSuppression,
 boolean writableStackTrace)

Method Details

getErrorDetails

public FrameworkErrorDetails getErrorDetails()

getErrorCode

public int getErrorCode()