org.springframework.integration.handler

Class LoggingHandler

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.handler.AbstractMessageHandler

org.springframework.integration.handler.LoggingHandler

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, Orderable, NamedComponent, ConfigurableMetricsAware<AbstractMessageHandlerMetrics>, IntegrationManagement, IntegrationStatsManagement, MessageHandlerMetrics, TrackableComponent, MessageHandler

public class LoggingHandler
extends AbstractMessageHandler

MessageHandler implementation that simply logs the Message or its payload depending on the value of the 'shouldLogFullMessage' 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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingHandler.Level

Field Summary

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

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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	setExpression(String expressionString)
void	setLevel(LoggingHandler.Level level) Set the logging LoggingHandler.Level.
void	setLoggerName(String loggerName)
void	setShouldLogFullMessage(boolean shouldLogFullMessage) Specify whether to log the full Message.

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

configureMetrics, getActiveCount, getActiveCountLong, getDuration, getErrorCount, getErrorCountLong, getHandleCount, getHandleCountLong, getManagedName, getManagedType, getMaxDuration, getMeanDuration, getMinDuration, getOrder, getStandardDeviationDuration, handleMessage, isCountsEnabled, isLoggingEnabled, isStatsEnabled, reset, setCountsEnabled, setLoggingEnabled, setManagedName, setManagedType, setOrder, setShouldTrack, setStatsEnabled

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

afterPropertiesSet, extractTypeIfPossible, getApplicationContext, getApplicationContextId, getBeanFactory, getChannelResolver, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

Methods inherited from class java.lang.Object

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

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

getComponentName

Constructor Detail

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.

Method Detail

setExpression

public void setExpression(String expressionString)

getLevel

public LoggingHandler.Level getLevel()

Returns:

The current logging LoggingHandler.Level.

setLevel

public void setLevel(LoggingHandler.Level level)

Set the logging LoggingHandler.Level.

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 AbstractMessageHandler

onInit

protected void onInit()
               throws Exception

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class AbstractMessageHandler

Throws:

Exception - Any exception.

handleMessageInternal

protected void handleMessageInternal(Message<?> message)
                              throws Exception

Specified by:

handleMessageInternal in class AbstractMessageHandler

Throws:

Exception