Package org.apache.camel.builder.endpoint.dsl

Interface LogEndpointBuilderFactory.LogEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver
Enclosing interface:
LogEndpointBuilderFactory
public static interface LogEndpointBuilderFactory.LogEndpointBuilder extends org.apache.camel.builder.EndpointProducerBuilder
Builder for endpoint for the Log component.

  • Method Details

    • advanced

      default LogEndpointBuilderFactory.AdvancedLogEndpointBuilder advanced()

    • groupActiveOnly

      default LogEndpointBuilderFactory.LogEndpointBuilder groupActiveOnly(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. The option is a: <code>java.lang.Boolean</code> type. Default: true Group: producer
      Parameters:
      groupActiveOnly - the value to set
      Returns:
      the dsl builder

    • groupActiveOnly

      default LogEndpointBuilderFactory.LogEndpointBuilder groupActiveOnly(String 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. The option will be converted to a <code>java.lang.Boolean</code> type. Default: true Group: producer
      Parameters:
      groupActiveOnly - the value to set
      Returns:
      the dsl builder

    • groupDelay

      default LogEndpointBuilderFactory.LogEndpointBuilder groupDelay(Long groupDelay)
      Set the initial delay for stats (in millis). The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      groupDelay - the value to set
      Returns:
      the dsl builder

    • groupDelay

      default LogEndpointBuilderFactory.LogEndpointBuilder groupDelay(String groupDelay)
      Set the initial delay for stats (in millis). The option will be converted to a <code>java.lang.Long</code> type. Group: producer
      Parameters:
      groupDelay - the value to set
      Returns:
      the dsl builder

    • groupInterval

      default LogEndpointBuilderFactory.LogEndpointBuilder groupInterval(Long groupInterval)
      If specified will group message stats by this time interval (in millis). The option is a: <code>java.lang.Long</code> type. Group: producer
      Parameters:
      groupInterval - the value to set
      Returns:
      the dsl builder

    • groupInterval

      default LogEndpointBuilderFactory.LogEndpointBuilder groupInterval(String groupInterval)
      If specified will group message stats by this time interval (in millis). The option will be converted to a <code>java.lang.Long</code> type. Group: producer
      Parameters:
      groupInterval - the value to set
      Returns:
      the dsl builder

    • groupSize

      default LogEndpointBuilderFactory.LogEndpointBuilder groupSize(Integer groupSize)
      An integer that specifies a group size for throughput logging. The option is a: <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      groupSize - the value to set
      Returns:
      the dsl builder

    • groupSize

      default LogEndpointBuilderFactory.LogEndpointBuilder groupSize(String groupSize)
      An integer that specifies a group size for throughput logging. The option will be converted to a <code>java.lang.Integer</code> type. Group: producer
      Parameters:
      groupSize - the value to set
      Returns:
      the dsl builder

    • level

      default LogEndpointBuilderFactory.LogEndpointBuilder level(String level)
      Logging level to use. The default value is INFO. The option is a: <code>java.lang.String</code> type. Default: INFO Group: producer
      Parameters:
      level - the value to set
      Returns:
      the dsl builder

    • logMask

      default LogEndpointBuilderFactory.LogEndpointBuilder logMask(Boolean logMask)
      If true, mask sensitive information like password or passphrase in the log. The option is a: <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      logMask - the value to set
      Returns:
      the dsl builder

    • logMask

      default LogEndpointBuilderFactory.LogEndpointBuilder logMask(String logMask)
      If true, mask sensitive information like password or passphrase in the log. The option will be converted to a <code>java.lang.Boolean</code> type. Group: producer
      Parameters:
      logMask - the value to set
      Returns:
      the dsl builder

    • marker

      default LogEndpointBuilderFactory.LogEndpointBuilder marker(String marker)
      An optional Marker name to use. The option is a: <code>java.lang.String</code> type. Group: producer
      Parameters:
      marker - the value to set
      Returns:
      the dsl builder

    • plain

      default LogEndpointBuilderFactory.LogEndpointBuilder plain(boolean plain)
      If enabled only the body will be printed out. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      plain - the value to set
      Returns:
      the dsl builder

    • plain

      default LogEndpointBuilderFactory.LogEndpointBuilder plain(String plain)
      If enabled only the body will be printed out. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
      Parameters:
      plain - the value to set
      Returns:
      the dsl builder

    • sourceLocationLoggerName

      default LogEndpointBuilderFactory.LogEndpointBuilder sourceLocationLoggerName(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. The option is a: <code>boolean</code> type. Default: false Group: producer
      Parameters:
      sourceLocationLoggerName - the value to set
      Returns:
      the dsl builder

    • sourceLocationLoggerName

      default LogEndpointBuilderFactory.LogEndpointBuilder sourceLocationLoggerName(String 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. The option will be converted to a <code>boolean</code> type. Default: false Group: producer
      Parameters:
      sourceLocationLoggerName - the value to set
      Returns:
      the dsl builder

    • maxChars

      default LogEndpointBuilderFactory.LogEndpointBuilder maxChars(int maxChars)
      Limits the number of characters logged per line. The option is a: <code>int</code> type. Default: 10000 Group: formatting
      Parameters:
      maxChars - the value to set
      Returns:
      the dsl builder

    • maxChars

      default LogEndpointBuilderFactory.LogEndpointBuilder maxChars(String maxChars)
      Limits the number of characters logged per line. The option will be converted to a <code>int</code> type. Default: 10000 Group: formatting
      Parameters:
      maxChars - the value to set
      Returns:
      the dsl builder

    • multiline

      default LogEndpointBuilderFactory.LogEndpointBuilder multiline(boolean multiline)
      If enabled then each information is outputted on a newline. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      multiline - the value to set
      Returns:
      the dsl builder

    • multiline

      default LogEndpointBuilderFactory.LogEndpointBuilder multiline(String multiline)
      If enabled then each information is outputted on a newline. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      multiline - the value to set
      Returns:
      the dsl builder

    • showAll

      default LogEndpointBuilderFactory.LogEndpointBuilder showAll(boolean showAll)
      Quick option for turning all options on. (multiline, maxChars has to be manually set if to be used). The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showAll - the value to set
      Returns:
      the dsl builder

    • showAll

      default LogEndpointBuilderFactory.LogEndpointBuilder showAll(String showAll)
      Quick option for turning all options on. (multiline, maxChars has to be manually set if to be used). The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showAll - the value to set
      Returns:
      the dsl builder

    • showAllProperties

      default LogEndpointBuilderFactory.LogEndpointBuilder showAllProperties(boolean showAllProperties)
      Show all of the exchange properties (both internal and custom). The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showAllProperties - the value to set
      Returns:
      the dsl builder

    • showAllProperties

      default LogEndpointBuilderFactory.LogEndpointBuilder showAllProperties(String showAllProperties)
      Show all of the exchange properties (both internal and custom). The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showAllProperties - the value to set
      Returns:
      the dsl builder

    • showBody

      default LogEndpointBuilderFactory.LogEndpointBuilder showBody(boolean showBody)
      Show the message body. The option is a: <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      showBody - the value to set
      Returns:
      the dsl builder

    • showBody

      default LogEndpointBuilderFactory.LogEndpointBuilder showBody(String showBody)
      Show the message body. The option will be converted to a <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      showBody - the value to set
      Returns:
      the dsl builder

    • showBodyType

      default LogEndpointBuilderFactory.LogEndpointBuilder showBodyType(boolean showBodyType)
      Show the body Java type. The option is a: <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      showBodyType - the value to set
      Returns:
      the dsl builder

    • showBodyType

      default LogEndpointBuilderFactory.LogEndpointBuilder showBodyType(String showBodyType)
      Show the body Java type. The option will be converted to a <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      showBodyType - the value to set
      Returns:
      the dsl builder

    • showCachedStreams

      default LogEndpointBuilderFactory.LogEndpointBuilder showCachedStreams(boolean showCachedStreams)
      Whether Camel should show cached stream bodies or not (org.apache.camel.StreamCache). The option is a: <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      showCachedStreams - the value to set
      Returns:
      the dsl builder

    • showCachedStreams

      default LogEndpointBuilderFactory.LogEndpointBuilder showCachedStreams(String showCachedStreams)
      Whether Camel should show cached stream bodies or not (org.apache.camel.StreamCache). The option will be converted to a <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      showCachedStreams - the value to set
      Returns:
      the dsl builder

    • showCaughtException

      default LogEndpointBuilderFactory.LogEndpointBuilder showCaughtException(boolean showCaughtException)
      If the exchange has a caught exception, show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key org.apache.camel.Exchange#EXCEPTION_CAUGHT) and for instance a doCatch can catch exceptions. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showCaughtException - the value to set
      Returns:
      the dsl builder

    • showCaughtException

      default LogEndpointBuilderFactory.LogEndpointBuilder showCaughtException(String showCaughtException)
      If the exchange has a caught exception, show the exception message (no stack trace). A caught exception is stored as a property on the exchange (using the key org.apache.camel.Exchange#EXCEPTION_CAUGHT) and for instance a doCatch can catch exceptions. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showCaughtException - the value to set
      Returns:
      the dsl builder

    • showException

      default LogEndpointBuilderFactory.LogEndpointBuilder showException(boolean showException)
      If the exchange has an exception, show the exception message (no stacktrace). The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showException - the value to set
      Returns:
      the dsl builder

    • showException

      default LogEndpointBuilderFactory.LogEndpointBuilder showException(String showException)
      If the exchange has an exception, show the exception message (no stacktrace). The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showException - the value to set
      Returns:
      the dsl builder

    • showExchangeId

      default LogEndpointBuilderFactory.LogEndpointBuilder showExchangeId(boolean showExchangeId)
      Show the unique exchange ID. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showExchangeId - the value to set
      Returns:
      the dsl builder

    • showExchangeId

      default LogEndpointBuilderFactory.LogEndpointBuilder showExchangeId(String showExchangeId)
      Show the unique exchange ID. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showExchangeId - the value to set
      Returns:
      the dsl builder

    • showExchangePattern

      default LogEndpointBuilderFactory.LogEndpointBuilder showExchangePattern(boolean showExchangePattern)
      Shows the Message Exchange Pattern (or MEP for short). The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showExchangePattern - the value to set
      Returns:
      the dsl builder

    • showExchangePattern

      default LogEndpointBuilderFactory.LogEndpointBuilder showExchangePattern(String showExchangePattern)
      Shows the Message Exchange Pattern (or MEP for short). The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showExchangePattern - the value to set
      Returns:
      the dsl builder

    • showFiles

      default LogEndpointBuilderFactory.LogEndpointBuilder showFiles(boolean showFiles)
      If enabled Camel will output files. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showFiles - the value to set
      Returns:
      the dsl builder

    • showFiles

      default LogEndpointBuilderFactory.LogEndpointBuilder showFiles(String showFiles)
      If enabled Camel will output files. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showFiles - the value to set
      Returns:
      the dsl builder

    • showFuture

      default LogEndpointBuilderFactory.LogEndpointBuilder showFuture(boolean showFuture)
      If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showFuture - the value to set
      Returns:
      the dsl builder

    • showFuture

      default LogEndpointBuilderFactory.LogEndpointBuilder showFuture(String showFuture)
      If enabled Camel will on Future objects wait for it to complete to obtain the payload to be logged. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showFuture - the value to set
      Returns:
      the dsl builder

    • showHeaders

      default LogEndpointBuilderFactory.LogEndpointBuilder showHeaders(boolean showHeaders)
      Show the message headers. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showHeaders - the value to set
      Returns:
      the dsl builder

    • showHeaders

      default LogEndpointBuilderFactory.LogEndpointBuilder showHeaders(String showHeaders)
      Show the message headers. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showHeaders - the value to set
      Returns:
      the dsl builder

    • showProperties

      default LogEndpointBuilderFactory.LogEndpointBuilder showProperties(boolean showProperties)
      Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showProperties - the value to set
      Returns:
      the dsl builder

    • showProperties

      default LogEndpointBuilderFactory.LogEndpointBuilder showProperties(String showProperties)
      Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showProperties - the value to set
      Returns:
      the dsl builder

    • showStackTrace

      default LogEndpointBuilderFactory.LogEndpointBuilder showStackTrace(boolean showStackTrace)
      Show the stack trace, if an exchange has an exception. Only effective if one of showAll, showException or showCaughtException are enabled. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showStackTrace - the value to set
      Returns:
      the dsl builder

    • showStackTrace

      default LogEndpointBuilderFactory.LogEndpointBuilder showStackTrace(String showStackTrace)
      Show the stack trace, if an exchange has an exception. Only effective if one of showAll, showException or showCaughtException are enabled. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showStackTrace - the value to set
      Returns:
      the dsl builder

    • showStreams

      default LogEndpointBuilderFactory.LogEndpointBuilder showStreams(boolean showStreams)
      Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use Stream Caching. The option is a: <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showStreams - the value to set
      Returns:
      the dsl builder

    • showStreams

      default LogEndpointBuilderFactory.LogEndpointBuilder showStreams(String showStreams)
      Whether Camel should show stream bodies or not (eg such as java.io.InputStream). Beware if you enable this option then you may not be able later to access the message body as the stream have already been read by this logger. To remedy this you will have to use Stream Caching. The option will be converted to a <code>boolean</code> type. Default: false Group: formatting
      Parameters:
      showStreams - the value to set
      Returns:
      the dsl builder

    • skipBodyLineSeparator

      default LogEndpointBuilderFactory.LogEndpointBuilder skipBodyLineSeparator(boolean skipBodyLineSeparator)
      Whether to skip line separators when logging the message body. This allows to log the message body in one line, setting this option to false will preserve any line separators from the body, which then will log the body as is. The option is a: <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      skipBodyLineSeparator - the value to set
      Returns:
      the dsl builder

    • skipBodyLineSeparator

      default LogEndpointBuilderFactory.LogEndpointBuilder skipBodyLineSeparator(String skipBodyLineSeparator)
      Whether to skip line separators when logging the message body. This allows to log the message body in one line, setting this option to false will preserve any line separators from the body, which then will log the body as is. The option will be converted to a <code>boolean</code> type. Default: true Group: formatting
      Parameters:
      skipBodyLineSeparator - the value to set
      Returns:
      the dsl builder

    • style

      default LogEndpointBuilderFactory.LogEndpointBuilder style(org.apache.camel.support.processor.DefaultExchangeFormatter.OutputStyle style)
      Sets the outputs style to use. The option is a: <code>org.apache.camel.support.processor.DefaultExchangeFormatter.OutputStyle</code> type. Default: Default Group: formatting
      Parameters:
      style - the value to set
      Returns:
      the dsl builder

    • style

      default LogEndpointBuilderFactory.LogEndpointBuilder style(String style)
      Sets the outputs style to use. The option will be converted to a <code>org.apache.camel.support.processor.DefaultExchangeFormatter.OutputStyle</code> type. Default: Default Group: formatting
      Parameters:
      style - the value to set
      Returns:
      the dsl builder