Package org.axonframework.messaging.core.interception

Class LoggingInterceptor<M extends Message>

java.lang.Object

org.axonframework.messaging.core.interception.LoggingInterceptor<M>

Type Parameters:

M - The message type this interceptor can process.

All Implemented Interfaces:

MessageDispatchInterceptor<M>, MessageHandlerInterceptor<M>

public class LoggingInterceptor<M extends Message>
extends Object
implements MessageDispatchInterceptor<M>, MessageHandlerInterceptor<M>

A MessageDispatchInterceptor and MessageHandlerInterceptor implementation that logs dispatched and incoming messages, and their result, to a Logger.

Allows configuration of the name under which the logger should log the statements.

Dispatched, incoming messages and successful executions are logged at the INFO level. Processing errors are logged using the WARN level.

Since:

0.6.0

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor	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	Description
MessageStream<?>	interceptOnDispatch(M message, ProcessingContext context, MessageDispatchInterceptorChain<M> interceptorChain)	Intercepts a given message on dispatching.
MessageStream<?>	interceptOnHandle(M message, ProcessingContext context, MessageHandlerInterceptorChain<M> interceptorChain)	Intercepts a given message on handling before reaching the designated MessageHandler.

Methods inherited from class java.lang.Object

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

Constructor Details

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 Details

interceptOnDispatch

@Nonnull
public MessageStream<?> interceptOnDispatch(@Nonnull
 M message,
 @Nullable
 ProcessingContext context,
 @Nonnull
 MessageDispatchInterceptorChain<M> interceptorChain)

Description copied from interface: MessageDispatchInterceptor

Intercepts a given message on dispatching.

The implementer of this method might want to intercept the message before passing it to the chain (effectively before calling MessageDispatchInterceptorChain.proceed(Message, ProcessingContext)) or after the chain (by mapping the resulting message by calling MessageStream.mapMessage(Function)).

Specified by:

interceptOnDispatch in interface MessageDispatchInterceptor<M extends Message>

Parameters:

message - The message to intercept on dispatching.

context - The active processing context, if any. Can be used to (e.g.) validate correlation data.

interceptorChain - The interceptor chain to signal that processing is finished and further interceptors should be called.

Returns:

The resulting message stream from MessageDispatchInterceptorChain.proceed(Message, ProcessingContext).

interceptOnHandle

@Nonnull
public MessageStream<?> interceptOnHandle(@Nonnull
 M message,
 @Nonnull
 ProcessingContext context,
 @Nonnull
 MessageHandlerInterceptorChain<M> interceptorChain)

Description copied from interface: MessageHandlerInterceptor

Intercepts a given message on handling before reaching the designated MessageHandler.

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

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

Interceptors are not allowed to change the type of the message handling result, as the dispatching component expects a result of a specific type.

Specified by:

interceptOnHandle in interface MessageHandlerInterceptor<M extends Message>

Parameters:

message - The message to intercept on handling.

context - The active processing context of the message being processed.

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

Returns:

The resulting message stream from MessageHandlerInterceptorChain.proceed(Message, ProcessingContext).