Package org.apache.camel.model

Class WireTapDefinition<Type extends ProcessorDefinition<Type>>

java.lang.Object
org.apache.camel.model.OptionalIdentifiedDefinition<Type>
org.apache.camel.model.ProcessorDefinition<Type>
org.apache.camel.model.NoOutputDefinition<ToDynamicDefinition>
org.apache.camel.model.ToDynamicDefinition
org.apache.camel.model.WireTapDefinition<Type>
All Implemented Interfaces:
org.apache.camel.CamelContextAware, org.apache.camel.LineNumberAware, Block, ExecutorServiceAwareDefinition<WireTapDefinition<Type>>, org.apache.camel.NamedNode, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.spi.IdAware
@Metadata(label="eip,routing") public class WireTapDefinition<Type extends ProcessorDefinition<Type>> extends ToDynamicDefinition implements ExecutorServiceAwareDefinition<WireTapDefinition<Type>>
Routes a copy of a message (or creates a new message) to a secondary destination while continue routing the original message.

  • Constructor Details

    • WireTapDefinition

      public WireTapDefinition()

  • Method Details

    • getPattern

      public String getPattern()
      Overrides:
      getPattern in class ToDynamicDefinition

    • toString

      public String toString()
      Overrides:
      toString in class ToDynamicDefinition

    • getShortName

      public String getShortName()
      Specified by:
      getShortName in interface org.apache.camel.NamedNode
      Overrides:
      getShortName in class ToDynamicDefinition

    • getLabel

      public String getLabel()
      Description copied from class: ProcessorDefinition
      Returns a label to describe this node such as the expression if some kind of expression node
      Specified by:
      getLabel in interface org.apache.camel.NamedNode
      Overrides:
      getLabel in class ToDynamicDefinition

    • end

      public Type end()
      Description copied from class: ProcessorDefinition
      Ends the current block
      Overrides:
      end in class ProcessorDefinition<ToDynamicDefinition>
      Returns:
      the builder

    • addOutput

      public void addOutput(ProcessorDefinition<?> output)
      Description copied from interface: Block
      Adds the given definition as output to this block
      Specified by:
      addOutput in interface Block
      Overrides:
      addOutput in class ProcessorDefinition<ToDynamicDefinition>
      Parameters:
      output - the processor definition

    • executorService

      public WireTapDefinition<Type> executorService(ExecutorService executorService)
      Uses a custom thread pool
      Specified by:
      executorService in interface ExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
      Parameters:
      executorService - a custom ExecutorService to use as thread pool for sending tapped exchanges
      Returns:
      the builder

    • executorService

      public WireTapDefinition<Type> executorService(String executorService)
      Uses a custom thread pool
      Specified by:
      executorService in interface ExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>
      Parameters:
      executorService - reference to lookup a custom ExecutorService to use as thread pool for sending tapped exchanges
      Returns:
      the builder

    • copy

      public WireTapDefinition<Type> copy()
      Uses a copy of the original exchange
      Returns:
      the builder

    • copy

      public WireTapDefinition<Type> copy(boolean copy)
      Uses a copy of the original exchange
      Parameters:
      copy - if it is true camel will copy the original exchange, if it is false camel will not copy the original exchange
      Returns:
      the builder

    • copy

      public WireTapDefinition<Type> copy(String copy)
      Uses a copy of the original exchange
      Parameters:
      copy - if it is true camel will copy the original exchange, if it is false camel will not copy the original exchange
      Returns:
      the builder

    • dynamicUri

      public WireTapDefinition<Type> dynamicUri(boolean dynamicUri)
      Whether the uri is dynamic or static. If the uri is dynamic then the simple language is used to evaluate a dynamic uri to use as the wire-tap destination, for each incoming message. This works similar to how the toD EIP pattern works. If static then the uri is used as-is as the wire-tap destination.
      Parameters:
      dynamicUri - whether to use dynamic or static uris
      Returns:
      the builder

    • dynamicUri

      public WireTapDefinition<Type> dynamicUri(String dynamicUri)
      Whether the uri is dynamic or static. If the uri is dynamic then the simple language is used to evaluate a dynamic uri to use as the wire-tap destination, for each incoming message. This works similar to how the toD EIP pattern works. If static then the uri is used as-is as the wire-tap destination.
      Parameters:
      dynamicUri - whether to use dynamic or static uris
      Returns:
      the builder

    • onPrepare

      public WireTapDefinition<Type> onPrepare(org.apache.camel.Processor onPrepare)
      Uses the Processor when preparing the Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.
      Parameters:
      onPrepare - the processor
      Returns:
      the builder

    • onPrepare

      public WireTapDefinition<Type> onPrepare(String onPrepare)
      Uses the Processor when preparing the Exchange to be sent. This can be used to deep-clone messages that should be sent, or any custom logic needed before the exchange is sent.
      Parameters:
      onPrepare - reference to the processor to lookup in the Registry
      Returns:
      the builder

    • cacheSize

      public WireTapDefinition<Type> cacheSize(int cacheSize)
      Sets the maximum size used by the ProducerCache which is used to cache and reuse producers, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then it's best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non-frequent used producers.
      Overrides:
      cacheSize in class ToDynamicDefinition
      Parameters:
      cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.
      Returns:
      the builder

    • cacheSize

      public WireTapDefinition<Type> cacheSize(String cacheSize)
      Sets the maximum size used by the ProducerCache which is used to cache and reuse producers, when uris are reused. Beware that when using dynamic endpoints then it affects how well the cache can be utilized. If each dynamic endpoint is unique then it's best to turn off caching by setting this to -1, which allows Camel to not cache both the producers and endpoints; they are regarded as prototype scoped and will be stopped and discarded after use. This reduces memory usage as otherwise producers/endpoints are stored in memory in the caches. However if there are a high degree of dynamic endpoints that have been used before, then it can benefit to use the cache to reuse both producers and endpoints and therefore the cache size can be set accordingly or rely on the default size (1000). If there is a mix of unique and used before dynamic endpoints, then setting a reasonable cache size can help reduce memory usage to avoid storing too many non-frequent used producers.
      Overrides:
      cacheSize in class ToDynamicDefinition
      Parameters:
      cacheSize - the cache size, use 0 for default cache size, or -1 to turn cache off.
      Returns:
      the builder

    • ignoreInvalidEndpoint

      public WireTapDefinition<Type> ignoreInvalidEndpoint()
      Ignore the invalid endpoint exception when try to create a producer with that endpoint
      Returns:
      the builder

    • getOnPrepareProcessor

      public org.apache.camel.Processor getOnPrepareProcessor()

    • getExecutorServiceBean

      public ExecutorService getExecutorServiceBean()
      Description copied from interface: ExecutorServiceAwareDefinition
      Gets the executor service for executing
      Specified by:
      getExecutorServiceBean in interface ExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>

    • getExecutorServiceRef

      public String getExecutorServiceRef()
      Description copied from interface: ExecutorServiceAwareDefinition
      Gets a reference id to lookup the executor service from the registry
      Specified by:
      getExecutorServiceRef in interface ExecutorServiceAwareDefinition<Type extends ProcessorDefinition<Type>>

    • getUri

      public String getUri()
      Overrides:
      getUri in class ToDynamicDefinition

    • setUri

      public void setUri(String uri)
      The uri of the endpoint to wiretap to. The uri can be dynamic computed using the simple language.
      Overrides:
      setUri in class ToDynamicDefinition

    • getCopy

      public String getCopy()

    • setCopy

      public void setCopy(String copy)

    • getDynamicUri

      public String getDynamicUri()

    • setDynamicUri

      public void setDynamicUri(String dynamicUri)

    • getOnPrepare

      public String getOnPrepare()

    • setOnPrepare

      public void setOnPrepare(String onPrepare)

    • getExecutorService

      public String getExecutorService()

    • setExecutorService

      public void setExecutorService(String executorService)