org.axonframework.messaging.interceptors

Class LoggingInterceptor<T extends Message<?>>

java.lang.Object

org.axonframework.messaging.interceptors.LoggingInterceptor<T>

All Implemented Interfaces:

MessageHandlerInterceptor<T>

public class LoggingInterceptor<T extends Message<?>>
extends Object
implements MessageHandlerInterceptor<T>

Message Handler Interceptor that logs incoming messages and their result to a SLF4J logger. Allow configuration of the name under which the logger should log the statements.

Incoming messages and successful executions are logged at the INFO level. Processing errors are logged using the WARN level.

Since:

0.6

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
LoggingInterceptor() Initialize the LoggingInterceptor with the default logger name, which is the fully qualified class name of this logger.
LoggingInterceptor(String loggerName) Initialize the LoggingInterceptor with the given loggerName.

Method Summary

Modifier and Type	Method and Description
Object	handle(UnitOfWork<? extends T> unitOfWork, InterceptorChain interceptorChain) Invoked before a Message is handled by a designated MessageHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingInterceptor

public LoggingInterceptor(String loggerName)

Initialize the LoggingInterceptor with the given loggerName. The actual logging implementation will use this name to decide the appropriate log level and location. See the documentation of your logging implementation for more information.

Parameters:

loggerName - the name of the logger

LoggingInterceptor

public LoggingInterceptor()

Initialize the LoggingInterceptor with the default logger name, which is the fully qualified class name of this logger.

See Also:

LoggingInterceptor(String)

Method Detail

handle

public Object handle(UnitOfWork<? extends T> unitOfWork,
                     InterceptorChain interceptorChain)
              throws Exception

Description copied from interface: MessageHandlerInterceptor

Invoked before a Message is handled by a designated MessageHandler.

The interceptor is responsible for the continuation of the handling process by invoking the InterceptorChain.proceed() method on the given interceptorChain.

The given unitOfWork contains contextual information. Any information gathered by interceptors may be attached to the unitOfWork.

Interceptors are highly recommended not to change the type of the message handling result, as the dispatching component might expect a result of a specific type.

Specified by:

handle in interface MessageHandlerInterceptor<T extends Message<?>>

Parameters:

unitOfWork - The UnitOfWork that is processing the message

interceptorChain - The interceptor chain that allows this interceptor to proceed the dispatch process

Returns:

the result of the message handler. May have been modified by interceptors.

Throws:

Exception - any exception that occurs while handling the message