Package org.springframework.integration.handler

Class LoggingHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.MessageHandlerSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.LoggingHandler

All Implemented Interfaces:

org.reactivestreams.Subscriber<Message<?>>, Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Ordered, ComponentSourceAware, ExpressionCapable, Orderable, IntegrationPattern, NamedComponent, IntegrationManagement, TrackableComponent, MessageHandler, reactor.core.CoreSubscriber<Message<?>>

public class LoggingHandler
extends AbstractMessageHandler

MessageHandler implementation that simply logs the Message or its payload depending on the value of the 'shouldLogFullMessage' or SpEL 'logExpression' property. If logging the payload, and it is assignable to Throwable, it will log the stack trace. By default, it will log the payload only.

Since:

1.0.1

Author:

Mark Fisher, Gary Russell, Artem Bilan, Andriy Kryvtsun

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LoggingHandler.Level

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
LoggingHandler(String level)	Create a LoggingHandler with the given log level (case-insensitive).
LoggingHandler(LoggingHandler.Level level)	Create a LoggingHandler with the given log LoggingHandler.Level.

Method Summary

Modifier and Type	Method	Description
String	getComponentType()	Subclasses may implement this method to provide component type information.
LoggingHandler.Level	getLevel()
protected void	handleMessageInternal(Message<?> message)
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setLevel(LoggingHandler.Level level)	Set the logging LoggingHandler.Level to change the behavior at runtime.
void	setLogExpression(Expression expression)	Set an Expression to evaluate a log entry at runtime against the request Message.
void	setLogExpressionString(String expressionString)	Set a SpEL expression string to use.
void	setLoggerName(String loggerName)
void	setShouldLogFullMessage(boolean shouldLogFullMessage)	Specify whether to log the full Message.

Methods inherited from class org.springframework.integration.handler.AbstractMessageHandler

handleMessage, onComplete, onError, onNext, onSubscribe, setObservationConvention

Methods inherited from class org.springframework.integration.handler.MessageHandlerSupport

buildSendTimer, destroy, getIntegrationPatternType, getManagedName, getManagedType, getMetricsCaptor, getObservationRegistry, getOrder, getOverrides, isLoggingEnabled, isObserved, registerMetricsCaptor, registerObservationRegistry, sendTimer, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, shouldTrack

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentDescription, getComponentName, getComponentSource, getConversionService, getExpression, getIntegrationProperties, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentDescription, setComponentName, setComponentSource, setConversionService, setMessageBuilderFactory, setPrimaryExpression, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.CoreSubscriber

currentContext

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getBeanName, getComponentName

Constructor Details

LoggingHandler

public LoggingHandler(String level)

Create a LoggingHandler with the given log level (case-insensitive).

The valid levels are: FATAL, ERROR, WARN, INFO, DEBUG, or TRACE

Parameters:

level - The level.

See Also:

• LoggingHandler(Level)

LoggingHandler

public LoggingHandler(LoggingHandler.Level level)

Create a LoggingHandler with the given log LoggingHandler.Level.

Parameters:

level - the LoggingHandler.Level to use.

Since:

4.3

Method Details

setLogExpressionString

public void setLogExpressionString(String expressionString)

Set a SpEL expression string to use.

Parameters:

expressionString - the SpEL expression string to use.

Since:

4.3

See Also:

• setLogExpression(Expression)

setLogExpression

public void setLogExpression(Expression expression)

Set an Expression to evaluate a log entry at runtime against the request Message.

Parameters:

expression - the Expression to use.

Since:

4.3

See Also:

• setLogExpressionString(String)

getLevel

public LoggingHandler.Level getLevel()

Returns:

The current logging LoggingHandler.Level.

setLevel

public void setLevel(LoggingHandler.Level level)

Set the logging LoggingHandler.Level to change the behavior at runtime.

Parameters:

level - the level.

setLoggerName

public void setLoggerName(String loggerName)

setShouldLogFullMessage

public void setShouldLogFullMessage(boolean shouldLogFullMessage)

Specify whether to log the full Message. Otherwise, only the payload will be logged. This value is false by default.

Parameters:

shouldLogFullMessage - true if the complete message should be logged.

getComponentType

public String getComponentType()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

Overrides:

getComponentType in class MessageHandlerSupport

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class IntegrationObjectSupport

handleMessageInternal

protected void handleMessageInternal(Message<?> message)

Specified by:

handleMessageInternal in class AbstractMessageHandler