Package io.vertx.camel
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
-
-
Field Summary
-
Fields inherited from class io.vertx.camel.CamelMapping
DEFAULT_HEADERS_COPY
-
-
Constructor Summary
Constructors Constructor Description OutboundMapping()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static OutboundMappingfromVertx(String address)Creates anOutboundMappingfrom the given Vert.x address.WorkerExecutorgetWorkerExecutor()booleanisBlocking()Whether the processing is blocking and so should not be executed on the event loop.OutboundMappingsetAddress(String address)Sets the event bus address.OutboundMappingsetBlocking(boolean blocking)Sets whether or not the processing is blocking.OutboundMappingsetEndpoint(org.apache.camel.Endpoint endpoint)Sets the Camel endpoint.OutboundMappingsetHeadersCopy(boolean copyHeaders)Sets whether or not the headers of the input message are copied in the output message.OutboundMappingsetUri(String uri)Sets the Camel endpoint URI.OutboundMappingsetWorkerExecutor(WorkerExecutor pool)Sets the worker thread worker used to execute the blocking processing.OutboundMappingtoCamel(String uri)Fluent version ofsetUri(String).OutboundMappingtoCamel(org.apache.camel.Endpoint endpoint)Fluent version ofsetEndpoint(Endpoint).OutboundMappingwithoutHeadersCopy()Fluent version ofsetHeadersCopy(boolean)to disable the headers copy.-
Methods inherited from class io.vertx.camel.CamelMapping
getAddress, getUri, isHeadersCopy
-
-
-
-
Method Detail
-
fromVertx
public static OutboundMapping fromVertx(String address)
Creates anOutboundMappingfrom the given Vert.x address.- Parameters:
address- the address - must not benull- Returns:
- the created
OutboundMapping
-
setAddress
public OutboundMapping setAddress(String address)
Description copied from class:CamelMappingSets the event bus address.- Overrides:
setAddressin classCamelMapping- Parameters:
address- the address- Returns:
- the current
CamelMapping
-
setHeadersCopy
public OutboundMapping setHeadersCopy(boolean copyHeaders)
Description copied from class:CamelMappingSets whether or not the headers of the input message are copied in the output message.- Overrides:
setHeadersCopyin classCamelMapping- Parameters:
copyHeaders-trueto copy the headers- Returns:
- the current
CamelMapping
-
setUri
public OutboundMapping setUri(String uri)
Description copied from class:CamelMappingSets the Camel endpoint URI.- Overrides:
setUriin classCamelMapping- Parameters:
uri- the uri- Returns:
- the current
CamelMapping
-
setEndpoint
public OutboundMapping setEndpoint(org.apache.camel.Endpoint endpoint)
Description copied from class:CamelMappingSets the Camel endpoint. If used,CamelMapping.setUri(String)does not need to be called.- Overrides:
setEndpointin classCamelMapping- Parameters:
endpoint- the endpoint- Returns:
- the current
CamelMapping
-
toCamel
public OutboundMapping toCamel(String uri)
Fluent version ofsetUri(String).- Parameters:
uri- the uri- Returns:
- the current instance of
OutboundMapping
-
toCamel
public OutboundMapping toCamel(org.apache.camel.Endpoint endpoint)
Fluent version ofsetEndpoint(Endpoint).- Parameters:
endpoint- the endpoint- Returns:
- the current instance of
OutboundMapping
-
withoutHeadersCopy
public OutboundMapping withoutHeadersCopy()
Fluent version ofsetHeadersCopy(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.falseby default.- Parameters:
blocking-trueto 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 totrue. 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
-
-