Package akka.camel

Interface ProducerSupport

All Superinterfaces:

Actor, CamelSupport

All Known Subinterfaces:

Oneway, Producer

All Known Implementing Classes:

UntypedProducerActor

public interface ProducerSupport
extends Actor, CamelSupport

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

Nested Class Summary

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

Actor.emptyBehavior$, Actor.ignoringBehavior$

Method Summary

Modifier and Type	Method	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.
void	messages_$eq(scala.collection.immutable.Vector<scala.Tuple2<ActorRef,java.lang.Object>> x$1)
boolean	oneway()	If set to false (default), this producer expects a response message from the Camel endpoint.
void	preStart()	User overridable callback.
scala.PartialFunction<java.lang.Object,scala.runtime.BoxedUnit>	produce()	Produces msg to the endpoint specified by endpointUri.
void	producerChild_$eq(scala.Option<ActorRef> x$1)
void	register()
void	routeResponse(java.lang.Object msg)	Called after a response was received from the endpoint specified by endpointUri.
void	super$preStart()
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

akka$camel$CamelSupport$_setter_$camel_$eq, camel, camelContext

Method Detail

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)

messages_$eq

void messages_$eq(scala.collection.immutable.Vector<scala.Tuple2<ActorRef,java.lang.Object>> x$1)

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)

preStart

void preStart()
       throws java.lang.Exception

Description copied from interface: Actor

User overridable callback.

Is called when an Actor is started. Actors are automatically started asynchronously when created. Empty default implementation.

Specified by:

preStart in interface Actor

Throws:

java.lang.Exception

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 transformOutgoingMessage. If oneway is true, an in-only message exchange is initiated, otherwise an in-out message exchange.

Returns:

(undocumented)

See Also:

produce()

producerChild_$eq

void producerChild_$eq(scala.Option<ActorRef> x$1)

register

void register()

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)

super$preStart

void super$preStart()

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)