akka.camel

Interface ProducerSupport

All Superinterfaces:

akka.actor.Actor, CamelSupport

All Known Subinterfaces:

Oneway, Producer

All Known Implementing Classes:

UntypedProducerActor

public interface ProducerSupport
extends akka.actor.Actor, CamelSupport

Support trait for producing messages to Camel endpoints.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
private static class	ProducerSupport.ProducerChild

Nested classes/interfaces inherited from interface akka.actor.Actor

akka.actor.Actor.emptyBehavior$

Method Summary

Modifier and Type	Method and Description
java.lang.String	endpointUri() Returns the Camel endpoint URI to produce messages to.
scala.collection.immutable.Set<java.lang.String>	headersToCopy() Returns the names of message headers to copy from a request message to a response message.
scala.collection.immutable.Set<java.lang.String>	headersToCopyDefault() CamelMessage headers to copy by default from request message to response-message.
boolean	oneway() If set to false (default), this producer expects a response message from the Camel endpoint.
void	preStart()
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	produce() Produces msg to the endpoint specified by endpointUri.
void	register()
void	routeResponse(java.lang.Object msg) Called after a response was received from the endpoint specified by endpointUri.
java.lang.Object	transformOutgoingMessage(java.lang.Object msg) Called before the message is sent to the endpoint specified by endpointUri.
java.lang.Object	transformResponse(java.lang.Object msg) Called before the response message is sent to the original sender.

Methods inherited from interface akka.actor.Actor

akka$actor$Actor$_setter_$context_$eq, akka$actor$Actor$_setter_$self_$eq, aroundPostRestart, aroundPostStop, aroundPreRestart, aroundPreStart, aroundReceive, context, postRestart, postStop, preRestart, receive, self, sender, supervisorStrategy, unhandled

Methods inherited from interface akka.camel.CamelSupport

camel, camelContext

Method Detail

preStart

void preStart()

Specified by:

preStart in interface akka.actor.Actor

register

void register()

headersToCopyDefault

scala.collection.immutable.Set<java.lang.String> headersToCopyDefault()

CamelMessage headers to copy by default from request message to response-message.

Returns:

(undocumented)

oneway

boolean oneway()

If set to false (default), this producer expects a response message from the Camel endpoint. If set to true, this producer initiates an in-only message exchange with the Camel endpoint (fire and forget).

Returns:

(undocumented)

endpointUri

java.lang.String endpointUri()

Returns the Camel endpoint URI to produce messages to.

Returns:

(undocumented)

headersToCopy

scala.collection.immutable.Set<java.lang.String> headersToCopy()

Returns the names of message headers to copy from a request message to a response message. By default only the CamelMessage.MessageExchangeId is copied. Applications may override this to define an application-specific set of message headers to copy.

Returns:

(undocumented)

produce

scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit> produce()

Produces msg to the endpoint specified by endpointUri. Before the message is actually sent it is pre-processed by calling receiveBeforeProduce. If oneway is true, an in-only message exchange is initiated, otherwise an in-out message exchange.

Returns:

(undocumented)

See Also:

Producer#produce(Any, ExchangePattern)

transformOutgoingMessage

java.lang.Object transformOutgoingMessage(java.lang.Object msg)

Called before the message is sent to the endpoint specified by endpointUri. The original message is passed as argument. By default, this method simply returns the argument but may be overridden by subtraits or subclasses.

Parameters:

msg - (undocumented)

Returns:

(undocumented)

transformResponse

java.lang.Object transformResponse(java.lang.Object msg)

Called before the response message is sent to the original sender. The original message is passed as argument. By default, this method simply returns the argument but may be overridden by subtraits or subclasses.

Parameters:

msg - (undocumented)

Returns:

(undocumented)

routeResponse

void routeResponse(java.lang.Object msg)

Called after a response was received from the endpoint specified by endpointUri. The response is passed as argument. By default, this method sends the response back to the original sender if oneway is false. If oneway is true, nothing is done. This method may be overridden by subtraits or subclasses (e.g. to forward responses to another actor).

Parameters:

msg - (undocumented)