org.apache.camel.component.log

Class LogEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.impl.DefaultPollingEndpoint

org.apache.camel.impl.ProcessorEndpoint

org.apache.camel.component.log.LogEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(firstVersion="1.1.0",
             scheme="log",
             title="Log",
             syntax="log:loggerName",
             producerOnly=true,
             label="core,monitoring")
public class LogEndpoint
extends ProcessorEndpoint

The log component logs message exchanges to the underlying logging mechanism. Camel uses sfl4j which allows you to configure logging to the actual logging system.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
LogEndpoint()
LogEndpoint(String endpointUri, Component component)
LogEndpoint(String endpointUri, Component component, Processor logger)

Method Summary

Modifier and Type	Method and Description
protected String	createEndpointUri() A factory method to lazily create the endpointUri if none is specified
protected Processor	createLogger() Creates the logger Processor to be used.
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
protected void	doStart() Implementations override this method to support customized start/stop.
protected void	doStop() Implementations override this method to support customized start/stop.
Boolean	getGroupActiveOnly() If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic.
Long	getGroupDelay() Set the initial delay for stats (in millis)
Long	getGroupInterval() If specified will group message stats by this time interval (in millis)
Integer	getGroupSize() An integer that specifies a group size for throughput logging.
String	getLevel() Logging level to use.
ExchangeFormatter	getLocalFormatter()
Processor	getLogger()
String	getLoggerName() The logger name to use
Boolean	getLogMask()
String	getMarker() An optional Marker name to use.
org.slf4j.Logger	getProvidedLogger()
void	setGroupActiveOnly(Boolean groupActiveOnly) If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic.
void	setGroupDelay(Long groupDelay) Set the initial delay for stats (in millis)
void	setGroupInterval(Long groupInterval) If specified will group message stats by this time interval (in millis)
void	setGroupSize(Integer groupSize) An integer that specifies a group size for throughput logging.
void	setLevel(String level) Logging level to use.
void	setLocalFormatter(ExchangeFormatter localFormatter)
void	setLogger(Processor logger)
void	setLoggerName(String loggerName) The logger name to use
void	setLogMask(Boolean logMask) If true, mask sensitive information like password or passphrase in the log.
void	setMarker(String marker) An optional Marker name to use.
void	setProvidedLogger(org.slf4j.Logger providedLogger)

Methods inherited from class org.apache.camel.impl.ProcessorEndpoint

createPollingConsumer, createProcessor, getProcessor, isSingleton, onExchange, setProcessor

Methods inherited from class org.apache.camel.impl.DefaultPollingEndpoint

createConsumer

Methods inherited from class org.apache.camel.impl.ScheduledPollEndpoint

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, createEndpointConfiguration, createExchange, createExchange, createExchange, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

LogEndpoint

public LogEndpoint()

LogEndpoint

public LogEndpoint(String endpointUri,
                   Component component)

LogEndpoint

public LogEndpoint(String endpointUri,
                   Component component,
                   Processor logger)

Method Detail

doStart

protected void doStart()
                throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: See ServiceSupport.doStop() for more details.

Overrides:

doStart in class ScheduledPollEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStop()

doStop

protected void doStop()
               throws Exception

Description copied from class: ServiceSupport

Implementations override this method to support customized start/stop.

Important: Camel will invoke this ServiceSupport.doStop() method when the service is being stopped. This method will also be invoked if the service is still in uninitialized state (eg has not been started). The method is always called to allow the service to do custom logic when the service is being stopped, such as when CamelContext is shutting down.

Overrides:

doStop in class ScheduledPollEndpoint

Throws:

Exception

See Also:

ServiceSupport.doStart()

setLogger

public void setLogger(Processor logger)

getLogger

public Processor getLogger()

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Overrides:

createProducer in class ProcessorEndpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createEndpointUri

protected String createEndpointUri()

Description copied from class: DefaultEndpoint

A factory method to lazily create the endpointUri if none is specified

Overrides:

createEndpointUri in class DefaultEndpoint

createLogger

protected Processor createLogger()
                          throws Exception

Creates the logger Processor to be used.

Throws:

Exception

getLevel

public String getLevel()

Logging level to use.

The default value is INFO.

setLevel

public void setLevel(String level)

Logging level to use.

The default value is INFO.

getMarker

public String getMarker()

An optional Marker name to use.

setMarker

public void setMarker(String marker)

An optional Marker name to use.

getGroupSize

public Integer getGroupSize()

An integer that specifies a group size for throughput logging.

setGroupSize

public void setGroupSize(Integer groupSize)

An integer that specifies a group size for throughput logging.

getGroupInterval

public Long getGroupInterval()

If specified will group message stats by this time interval (in millis)

setGroupInterval

public void setGroupInterval(Long groupInterval)

If specified will group message stats by this time interval (in millis)

getGroupActiveOnly

public Boolean getGroupActiveOnly()

If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic.

setGroupActiveOnly

public void setGroupActiveOnly(Boolean groupActiveOnly)

If true, will hide stats when no new messages have been received for a time interval, if false, show stats regardless of message traffic.

getGroupDelay

public Long getGroupDelay()

Set the initial delay for stats (in millis)

setGroupDelay

public void setGroupDelay(Long groupDelay)

Set the initial delay for stats (in millis)

getLocalFormatter

public ExchangeFormatter getLocalFormatter()

setLocalFormatter

public void setLocalFormatter(ExchangeFormatter localFormatter)

getProvidedLogger

public org.slf4j.Logger getProvidedLogger()

setProvidedLogger

public void setProvidedLogger(org.slf4j.Logger providedLogger)

getLoggerName

public String getLoggerName()

The logger name to use

setLoggerName

public void setLoggerName(String loggerName)

The logger name to use

getLogMask

public Boolean getLogMask()

setLogMask

public void setLogMask(Boolean logMask)

If true, mask sensitive information like password or passphrase in the log.