com.kdgregory.logging.aws.facade

Class FacadeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.kdgregory.logging.aws.facade.FacadeException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CloudWatchFacadeException, KinesisFacadeException, SNSFacadeException

public class FacadeException
extends RuntimeException

A wrapper for any exceptions that happen inside a facade implementation. Provides information about where the exception occurred, and whether it's retryable.

Note that the "major" facades have their own subclasses of this exception, which provide additional information that can be used to control the caller's subsequent action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FacadeException(String message, Throwable cause, boolean isRetryable, String functionName, Object... args) Base constructor.

Method Summary

Modifier and Type	Method and Description
String	getFunctionName() Returns the function that throw this exception (included for completeness).
boolean	isRetryable() Returns an indication of whether the caller should retry the operation that threw this exception.

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

Constructor Detail

FacadeException

public FacadeException(String message,
                       Throwable cause,
                       boolean isRetryable,
                       String functionName,
                       Object... args)

Base constructor.

Parameters:

message - A base message explaining what happened. The actual exception message consists of this, prefixed by the function name and arguments.

cause - The underlying exception wrapped by this. May be null.

isRetryable - Indicates whether the caller can retry the operation.

functionName - The name of the function where this exception was thrown.

args - Optional information about the function state (usually the arguments that were passed to the function).

Method Detail

getFunctionName

public String getFunctionName()

Returns the function that throw this exception (included for completeness).

isRetryable

public boolean isRetryable()

Returns an indication of whether the caller should retry the operation that threw this exception. Depending on the operation, callers may need to look at a subclass reason code.