FluentProducerTemplate (Camel :: Core 2.22.2 API)

All Superinterfaces:

Service

All Known Implementing Classes:

DefaultFluentProducerTemplate
```
public interface FluentProducerTemplate
extends Service
```
Template for working with Camel and sending Message instances in an Exchange to an Endpoint using a fluent build style.

Important: Read the javadoc of each method carefully to ensure the behavior of the method is understood. Some methods is for InOnly, others for InOut MEP. And some methods throws CamelExecutionException while others stores any thrown exception on the returned Exchange.

The FluentProducerTemplate is thread safe.

All the methods which sends a message may throw FailedToCreateProducerException in case the Producer could not be created. Or a NoSuchEndpointException if the endpoint could not be resolved. There may be other related exceptions being thrown which occurs before the Producer has started sending the message.

All the send or request methods will return the content according to this strategy:
- throws CamelExecutionException if processing failed during routing with the caused exception wrapped
- The fault.body if there is a fault message set and its not null
- Either IN or OUT body according to the message exchange pattern. If the pattern is Out capable then the OUT body is returned, otherwise IN.
Before using the template it must be started. And when you are done using the template, make sure to Service.stop() the template.

Important note on usage: See this FAQ entry before using.
See Also:

ProducerTemplate, ConsumerTemplate

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Future<Object>`	`asyncRequest()` Sends asynchronously to the given endpoint (InOut).
`<T> Future<T>`	`asyncRequest(Class<T> type)` Sends asynchronously to the given endpoint (InOut).
`Future<Exchange>`	`asyncSend()` Sends asynchronously to the given endpoint (InOnly).
`void`	`cleanUp()` Cleanup the cache (purging stale entries)
`FluentProducerTemplate`	`clearAll()` Remove the body and headers.
`FluentProducerTemplate`	`clearBody()` Remove the body.
`FluentProducerTemplate`	`clearHeaders()` Remove the headers.
`CamelContext`	`getCamelContext()` Get the `CamelContext`
`int`	`getCurrentCacheSize()` Gets an approximated size of the current cached resources in the backing cache pools.
`Endpoint`	`getDefaultEndpoint()` Get the default endpoint to use if none is specified
`int`	`getMaximumCacheSize()` Gets the maximum cache size used in the backing cache pools.
`boolean`	`isEventNotifierEnabled()` Whether the `EventNotifier` should be used by this `ProducerTemplate` to send events about the `Exchange` being sent.
`Object`	`request()` Send to an endpoint (InOut) returning any result output body.
`<T> T`	`request(Class<T> type)` Send to an endpoint (InOut).
`Exchange`	`send()` Send to an endpoint (InOnly)
`void`	`setDefaultEndpoint(Endpoint defaultEndpoint)` Sets the default endpoint to use if none is specified
`void`	`setDefaultEndpointUri(String endpointUri)` Sets the default endpoint uri to use if none is specified
`void`	`setEventNotifierEnabled(boolean enabled)` Sets whether the `EventNotifier` should be used by this `ProducerTemplate` to send events about the `Exchange` being sent.
`void`	`setMaximumCacheSize(int maximumCacheSize)` Sets a custom maximum cache size to use in the backing cache pools.
`FluentProducerTemplate`	`to(Endpoint endpoint)` Endpoint to send to
`FluentProducerTemplate`	`to(String endpointUri)` Endpoint to send to
`FluentProducerTemplate`	`withBody(Object body)` Set the message body
`FluentProducerTemplate`	`withBodyAs(Object body, Class<?> type)` Set the message body after converting it to the given type
`FluentProducerTemplate`	`withExchange(Exchange exchange)` Set the exchange to use for send.
`FluentProducerTemplate`	`withExchange(Supplier<Exchange> exchangeSupplier)` Set the exchangeSupplier which will be invoke to get the exchange to be used for send.
`FluentProducerTemplate`	`withHeader(String key, Object value)` Set the header
`FluentProducerTemplate`	`withProcessor(Processor processor)` Set the processor to use for send/request.
`FluentProducerTemplate`	`withProcessor(Supplier<Processor> processorSupplier)` Set the processorSupplier which will be invoke to get the processor to be used for send/request.
`FluentProducerTemplate`	`withTemplateCustomizer(Consumer<ProducerTemplate> templateCustomizer)` To customize the producer template for advanced usage like to set the executor service to use.

Methods inherited from interface org.apache.camel.Service
start, stop

- Method Detail
  - getCamelContext
```
CamelContext getCamelContext()
```
    Get the CamelContext
    
    Returns:
    
    camelContext the Camel context
  - getMaximumCacheSize
```
int getMaximumCacheSize()
```
    Gets the maximum cache size used in the backing cache pools.
    
    Returns:
    
    the maximum cache size
  - setMaximumCacheSize
```
void setMaximumCacheSize(int maximumCacheSize)
```
    Sets a custom maximum cache size to use in the backing cache pools.
    
    Parameters:
    
    maximumCacheSize - the custom maximum cache size
  - getCurrentCacheSize
```
int getCurrentCacheSize()
```
    Gets an approximated size of the current cached resources in the backing cache pools.
    
    Returns:
    
    the size of current cached resources
  - getDefaultEndpoint
```
Endpoint getDefaultEndpoint()
```
    Get the default endpoint to use if none is specified
    
    Returns:
    
    the default endpoint instance
  - setDefaultEndpoint
```
void setDefaultEndpoint(Endpoint defaultEndpoint)
```
    Sets the default endpoint to use if none is specified
    
    Parameters:
    
    defaultEndpoint - the default endpoint instance
  - setDefaultEndpointUri
```
void setDefaultEndpointUri(String endpointUri)
```
    Sets the default endpoint uri to use if none is specified
    
    Parameters:
    
    endpointUri - the default endpoint uri
  - setEventNotifierEnabled
```
void setEventNotifierEnabled(boolean enabled)
```
    Sets whether the EventNotifier should be used by this ProducerTemplate to send events about the Exchange being sent.
    By default this is enabled.
    
    Parameters:
    
    enabled - true to enable, false to disable.
  - isEventNotifierEnabled
```
boolean isEventNotifierEnabled()
```
    Whether the EventNotifier should be used by this ProducerTemplate to send events about the Exchange being sent.
    
    Returns:
    
    true if enabled, false otherwise
  - cleanUp
```
void cleanUp()
```
    Cleanup the cache (purging stale entries)
  - clearAll
```
FluentProducerTemplate clearAll()
```
    Remove the body and headers.
  - withHeader
```
FluentProducerTemplate withHeader(String key,
                                  Object value)
```
    Set the header
    
    Parameters:
    
    key - the key of the header
    
    value - the value of the header
  - clearHeaders
```
FluentProducerTemplate clearHeaders()
```
    Remove the headers.
  - withBody
```
FluentProducerTemplate withBody(Object body)
```
    Set the message body
    
    Parameters:
    
    body - the body
  - withBodyAs
```
FluentProducerTemplate withBodyAs(Object body,
                                  Class<?> type)
```
    Set the message body after converting it to the given type
    
    Parameters:
    
    body - the body
    
    type - the type which the body should be converted to
  - clearBody
```
FluentProducerTemplate clearBody()
```
    Remove the body.
  - withTemplateCustomizer
```
FluentProducerTemplate withTemplateCustomizer(Consumer<ProducerTemplate> templateCustomizer)
```
    To customize the producer template for advanced usage like to set the executor service to use.
```
 
 FluentProducerTemplate.on(context)
     .withTemplateCustomizer(
         template -> {
             template.setExecutorService(myExecutor);
             template.setMaximumCacheSize(10);
         }
      )
     .withBody("the body")
     .to("direct:start")
     .request()
 
```
    Note that it is invoked only once.
    Parameters:
    
    templateCustomizer - the customizer
  - withExchange
```
FluentProducerTemplate withExchange(Exchange exchange)
```
    Set the exchange to use for send.
    
    Parameters:
    
    exchange - the exchange
  - withExchange
```
FluentProducerTemplate withExchange(Supplier<Exchange> exchangeSupplier)
```
    Set the exchangeSupplier which will be invoke to get the exchange to be used for send.
    
    Parameters:
    
    exchangeSupplier - the supplier
  - withProcessor
```
FluentProducerTemplate withProcessor(Processor processor)
```
    Set the processor to use for send/request.
```
 
 FluentProducerTemplate.on(context)
     .withProcessor(
         exchange -> {
             exchange.getIn().setHeader("Key1", "Val1");
             exchange.getIn().setHeader("Key2", "Val2");
             exchange.getIn().setBody("the body");
         }
      )
     .to("direct:start")
     .request()
 
```
    Parameters:
    
    processor -
  - withProcessor
```
FluentProducerTemplate withProcessor(Supplier<Processor> processorSupplier)
```
    Set the processorSupplier which will be invoke to get the processor to be used for send/request.
    
    Parameters:
    
    processorSupplier - the supplier
  - to
```
FluentProducerTemplate to(String endpointUri)
```
    Endpoint to send to
    
    Parameters:
    
    endpointUri - the endpoint URI to send to
  - to
```
FluentProducerTemplate to(Endpoint endpoint)
```
    Endpoint to send to
    
    Parameters:
    
    endpoint - the endpoint to send to
  - request
```
Object request()
        throws CamelExecutionException
```
    Send to an endpoint (InOut) returning any result output body.
    
    Returns:
    
    the result
    
    Throws:
    
    CamelExecutionException - is thrown if error occurred
  - request
```
<T> T request(Class<T> type)
       throws CamelExecutionException
```
    Send to an endpoint (InOut).
    
    Parameters:
    
    type - the expected response type
    
    Returns:
    
    the result
    
    Throws:
    
    CamelExecutionException - is thrown if error occurred
  - asyncRequest
```
Future<Object> asyncRequest()
```
    Sends asynchronously to the given endpoint (InOut).
    
    Returns:
    
    a handle to be used to get the response in the future
  - asyncRequest
```
<T> Future<T> asyncRequest(Class<T> type)
```
    Sends asynchronously to the given endpoint (InOut).
    
    Parameters:
    
    type - the expected response type
    
    Returns:
    
    a handle to be used to get the response in the future
  - send
```
Exchange send()
       throws CamelExecutionException
```
    Send to an endpoint (InOnly)
    
    Throws:
    
    CamelExecutionException - is thrown if error occurred
  - asyncSend
```
Future<Exchange> asyncSend()
```
    Sends asynchronously to the given endpoint (InOnly).
    
    Returns:
    
    a handle to be used to get the response in the future

Interface FluentProducerTemplate

Method Summary

Methods inherited from interface org.apache.camel.Service

Method Detail

getCamelContext

getMaximumCacheSize

setMaximumCacheSize

getCurrentCacheSize

getDefaultEndpoint

setDefaultEndpoint

setDefaultEndpointUri

setEventNotifierEnabled

isEventNotifierEnabled

cleanUp

clearAll

withHeader

clearHeaders

withBody

withBodyAs

clearBody

withTemplateCustomizer

withExchange

withExchange

withProcessor

withProcessor

to

to

request

request

asyncRequest

asyncRequest

send

asyncSend