Package org.apache.camel.component.log

Class LogComponent

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultComponent
org.apache.camel.component.log.LogComponent
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.Component, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@Component("log") public class LogComponent extends org.apache.camel.support.DefaultComponent
The Log Component is for logging message exchanges via the underlying logging mechanism.

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    LogComponent()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected org.apache.camel.Endpoint
    createEndpoint(String uri, String remaining, Map<String,Object> parameters)
     
    protected void
    doInit()
     
    org.apache.camel.spi.ExchangeFormatter
    getDefaultExchangeFormatter()
    Gets the default shared exchange formatter.
    org.apache.camel.spi.ExchangeFormatter
    getExchangeFormatter()
     
    protected org.slf4j.Logger
    getLogger(Map<String,Object> parameters)
    Gets optional Logger instance from parameters.
    protected org.apache.camel.LoggingLevel
    getLoggingLevel(Map<String,Object> parameters)
    Gets the logging level, will default to use INFO if no level parameter provided.
    boolean
    isSourceLocationLoggerName()
     
    void
    setExchangeFormatter(org.apache.camel.spi.ExchangeFormatter exchangeFormatter)
    Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging.
    void
    setSourceLocationLoggerName(boolean sourceLocationLoggerName)
    If enabled then the source location of where the log endpoint is used in Camel routes, would be used as logger name, instead of the given name.

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

    afterConfiguration, createEndpoint, createEndpoint, doBuild, getAndRemoveOrResolveReferenceParameter, getAndRemoveOrResolveReferenceParameter, getAndRemoveParameter, getAndRemoveParameter, getCamelContext, getComponentPropertyConfigurer, getDefaultName, getEndpointPropertyConfigurer, getExtension, getSupportedExtensions, ifStartsWithReturnRemainder, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, registerExtension, registerExtension, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceListParameter, resolveAndRemoveReferenceParameter, resolveAndRemoveReferenceParameter, resolveRawParameterValues, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setLazyStartProducer, setProperties, setProperties, setProperties, useIntrospectionOnEndpoint, useRawUri, validateParameters, validateURI

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doFail, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • LogComponent

      public LogComponent()

  • Method Details

    • createEndpoint

      protected org.apache.camel.Endpoint createEndpoint(String uri, String remaining, Map<String,Object> parameters) throws Exception
      Specified by:
      createEndpoint in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception

    • getLoggingLevel

      protected org.apache.camel.LoggingLevel getLoggingLevel(Map<String,Object> parameters)
      Gets the logging level, will default to use INFO if no level parameter provided.

    • getLogger

      protected org.slf4j.Logger getLogger(Map<String,Object> parameters)
      Gets optional Logger instance from parameters. If non-null, the provided instance will be used as Logger in CamelLogger
      Parameters:
      parameters - the parameters
      Returns:
      the Logger object from the parameter

    • getExchangeFormatter

      public org.apache.camel.spi.ExchangeFormatter getExchangeFormatter()

    • setExchangeFormatter

      public void setExchangeFormatter(org.apache.camel.spi.ExchangeFormatter exchangeFormatter)
      Sets a custom ExchangeFormatter to convert the Exchange to a String suitable for logging. If not specified, we default to DefaultExchangeFormatter.

    • isSourceLocationLoggerName

      public boolean isSourceLocationLoggerName()

    • setSourceLocationLoggerName

      public void setSourceLocationLoggerName(boolean sourceLocationLoggerName)
      If enabled then the source location of where the log endpoint is used in Camel routes, would be used as logger name, instead of the given name. However, if the source location is disabled or not possible to resolve then the existing logger name will be used.

    • getDefaultExchangeFormatter

      public org.apache.camel.spi.ExchangeFormatter getDefaultExchangeFormatter()
      Gets the default shared exchange formatter.

    • doInit

      protected void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.DefaultComponent
      Throws:
      Exception