org.axonframework.messaging

Class HandlerExecutionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.axonframework.common.AxonException

org.axonframework.messaging.HandlerExecutionException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandExecutionException, QueryExecutionException

public abstract class HandlerExecutionException
extends AxonException

Base exception for exceptions raised by Handler methods. Besides standard exception information (such as message and cause), these exception may optionally carry an object with additional application-specific details about the exception.

By default, a stack trace is not generated for this exception. However, the stack trace creation can be enforced explicitly via the constructor accepting the writableStackTrace parameter.

Since:

4.2

Author:

Allard Buize

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HandlerExecutionException(String message) Initializes an execution exception with given message.
HandlerExecutionException(String message, Throwable cause) Initializes an execution exception with given message and cause.
HandlerExecutionException(String message, Throwable cause, Object details) Initializes an execution exception with given message, cause and application-specific details.
HandlerExecutionException(String message, Throwable cause, Object details, boolean writableStackTrace) Initializes an execution exception with given message, cause, application-specific details, and writableStackTrace

Method Summary

Modifier and Type	Method and Description
<R> Optional<R>	getDetails() Returns an Optional containing application-specific details of the exception, if any were provided.
static <R> Optional<R>	resolveDetails(Throwable throwable) Resolve details from the given throwable, taking into account that the details may be available in any of the HandlerExecutionExceptions is the "cause" chain.

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

HandlerExecutionException

public HandlerExecutionException(String message)

Initializes an execution exception with given message. The cause and application-specific details are set to null.

Parameters:

message - A message describing the exception

HandlerExecutionException

public HandlerExecutionException(String message,
                                 Throwable cause)

Initializes an execution exception with given message and cause. The application-specific details are set to null.

Parameters:

message - A message describing the exception

cause - the cause of the execution exception

HandlerExecutionException

public HandlerExecutionException(String message,
                                 Throwable cause,
                                 Object details)

Initializes an execution exception with given message, cause and application-specific details.

Parameters:

message - A message describing the exception

cause - The cause of the execution exception

details - An object providing application-specific details of the exception

HandlerExecutionException

public HandlerExecutionException(String message,
                                 Throwable cause,
                                 Object details,
                                 boolean writableStackTrace)

Initializes an execution exception with given message, cause, application-specific details, and writableStackTrace

Parameters:

message - A message describing the exception

cause - The cause of the execution exception

details - An object providing application-specific details of the exception

writableStackTrace - Whether the stack trace should be generated (true) or not (false)

Method Detail

resolveDetails

public static <R> Optional<R> resolveDetails(Throwable throwable)

Resolve details from the given throwable, taking into account that the details may be available in any of the HandlerExecutionExceptions is the "cause" chain.

Type Parameters:

R - The type of details expected

Parameters:

throwable - The exception to resolve the details from

Returns:

an Optional containing details, if present in the given throwable

getDetails

public <R> Optional<R> getDetails()

Returns an Optional containing application-specific details of the exception, if any were provided. These details are implicitly cast to the expected type. A mismatch in type may lead to a ClassCastException further downstream, when accessing the Optional's enclosed value.

Type Parameters:

R - The type of details expected

Returns:

an Optional containing the details, if provided