Class OutboundMapping

java.lang.Object
io.vertx.camel.CamelMapping
io.vertx.camel.OutboundMapping
public class OutboundMapping extends CamelMapping
Represents a mapping between a Vert.x event bus address and a Camel endpoint.
Author:
Clement Escoffier

  • Constructor Details

    • OutboundMapping

      public OutboundMapping()

  • Method Details

    • fromVertx

      public static OutboundMapping fromVertx(String address)
      Creates an OutboundMapping from the given Vert.x address.
      Parameters:
      address - the address - must not be null
      Returns:
      the created OutboundMapping

    • setAddress

      public OutboundMapping setAddress(String address)
      Description copied from class: CamelMapping
      Sets the event bus address.
      Overrides:
      setAddress in class CamelMapping
      Parameters:
      address - the address
      Returns:
      the current CamelMapping

    • setHeadersCopy

      public OutboundMapping setHeadersCopy(boolean copyHeaders)
      Description copied from class: CamelMapping
      Sets whether or not the headers of the input message are copied in the output message.
      Overrides:
      setHeadersCopy in class CamelMapping
      Parameters:
      copyHeaders - true to copy the headers
      Returns:
      the current CamelMapping

    • setUri

      public OutboundMapping setUri(String uri)
      Description copied from class: CamelMapping
      Sets the Camel endpoint URI.
      Overrides:
      setUri in class CamelMapping
      Parameters:
      uri - the uri
      Returns:
      the current CamelMapping

    • setEndpoint

      public OutboundMapping setEndpoint(org.apache.camel.Endpoint endpoint)
      Description copied from class: CamelMapping
      Sets the Camel endpoint. If used, CamelMapping.setUri(String) does not need to be called.
      Overrides:
      setEndpoint in class CamelMapping
      Parameters:
      endpoint - the endpoint
      Returns:
      the current CamelMapping

    • toCamel

      public OutboundMapping toCamel(String uri)
      Fluent version of setUri(String).
      Parameters:
      uri - the uri
      Returns:
      the current instance of OutboundMapping

    • toCamel

      public OutboundMapping toCamel(org.apache.camel.Endpoint endpoint)
      Fluent version of setEndpoint(Endpoint).
      Parameters:
      endpoint - the endpoint
      Returns:
      the current instance of OutboundMapping

    • withoutHeadersCopy

      public OutboundMapping withoutHeadersCopy()
      Fluent version of setHeadersCopy(boolean) to disable the headers copy.
      Returns:
      the current instance of OutboundMapping

    • isBlocking

      public boolean isBlocking()
      Whether the processing is blocking and so should not be executed on the event loop.
      Returns:
      whether or not the processing is blocking

    • setBlocking

      public OutboundMapping setBlocking(boolean blocking)
      Sets whether or not the processing is blocking. false by default.
      Parameters:
      blocking - true to set it to blocking.
      Returns:
      the current instance of OutboundMapping

    • getWorkerExecutor

      public WorkerExecutor getWorkerExecutor()
      Returns:
      the worker thread worker to use to execute the processing. This option is only used if blocking is set to true. If not set, it uses the the default worker worker.

    • setWorkerExecutor

      public OutboundMapping setWorkerExecutor(WorkerExecutor pool)
      Sets the worker thread worker used to execute the blocking processing. This option is only used if blocking is set to true. If not set, it uses the the default worker worker.
      Parameters:
      pool - the worker worker on which the code is executed
      Returns:
      the current instance of OutboundMapping