abstract class UntypedConsumerActor extends UntypedActor with Consumer
Subclass this abstract class to create an MDB-style untyped consumer actor. This class is meant to be used from Java.
- Annotations
- @Deprecated
- Deprecated
Akka Camel is deprecated since 2.5.0 in favour of 'Alpakka', the Akka Streams based collection of integrations to various endpoints (including Camel).
- Source
- UntypedConsumerActor.scala
- Alphabetic
- By Inheritance
- UntypedConsumerActor
- Consumer
- CamelSupport
- UntypedActor
- Actor
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
UntypedConsumerActor()
- Deprecated
Akka Camel is deprecated since 2.5.0 in favour of 'Alpakka', the Akka Streams based collection of integrations to various endpoints (including Camel).
Type Members
-
type
Receive = PartialFunction[Any, Unit]
- Definition Classes
- Actor
Abstract Value Members
-
abstract
def
getEndpointUri(): String
Java API: Returns the Camel endpoint URI to consume messages from.
-
abstract
def
onReceive(message: Any): Unit
To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor.
To be implemented by concrete UntypedActor, this defines the behavior of the UntypedActor.
- Definition Classes
- UntypedActor
- Annotations
- @throws( classOf[Throwable] )
Concrete Value Members
-
def
activationTimeout: FiniteDuration
How long the actor should wait for activation before it fails.
How long the actor should wait for activation before it fails.
- Definition Classes
- Consumer
-
def
autoAck: Boolean
Determines whether one-way communications between an endpoint and this consumer actor should be auto-acknowledged or application-acknowledged.
Determines whether one-way communications between an endpoint and this consumer actor should be auto-acknowledged or application-acknowledged. This flag has only effect when exchange is in-only.
- Definition Classes
- Consumer
-
implicit
val
context: ActorContext
Scala API: Stores the context for this actor, including self, and sender.
Scala API: Stores the context for this actor, including self, and sender. It is implicit to support operations such as
forward
.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
akka.actor.ActorContext is the Scala API.
getContext
returns a akka.actor.AbstractActor.ActorContext, which is the Java API of the actor context.- Definition Classes
- Actor
-
final
def
endpointUri: String
Must return the Camel endpoint URI that the consumer wants to consume messages from.
Must return the Camel endpoint URI that the consumer wants to consume messages from.
- Definition Classes
- UntypedConsumerActor → Consumer
-
def
getContext(): UntypedActorContext
Returns this UntypedActor's UntypedActorContext The UntypedActorContext is not thread safe so do not expose it outside of the UntypedActor.
Returns this UntypedActor's UntypedActorContext The UntypedActorContext is not thread safe so do not expose it outside of the UntypedActor.
- Definition Classes
- UntypedActor
-
def
getRouteDefinitionHandler: Mapper[RouteDefinition, ProcessorDefinition[_]]
Java API: Returns the akka.dispatch.Mapper function that will be used as a route definition handler for creating custom route to this consumer.
Java API: Returns the akka.dispatch.Mapper function that will be used as a route definition handler for creating custom route to this consumer. By default it returns an identity function, override this method to return a custom route definition handler. The akka.dispatch.Mapper is not allowed to close over 'this', meaning it is not allowed to refer to the actor instance itself, since that can easily cause concurrent shared state issues.
- Definition Classes
- Consumer
-
def
getSelf(): ActorRef
Returns the ActorRef for this actor.
Returns the ActorRef for this actor.
- Definition Classes
- UntypedActor
-
def
getSender(): ActorRef
The reference sender Actor of the currently processed message.
The reference sender Actor of the currently processed message. This is always a legal destination to send to, even if there is no logical recipient for the reply, in which case it will be sent to the dead letter mailbox.
- Definition Classes
- UntypedActor
-
def
onRouteDefinition: (RouteDefinition) ⇒ ProcessorDefinition[_]
Returns the route definition handler for creating a custom route to this consumer.
Returns the route definition handler for creating a custom route to this consumer. By default it returns an identity function, override this method to return a custom route definition handler. The returned function is not allowed to close over 'this', meaning it is not allowed to refer to the actor instance itself, since that can easily cause concurrent shared state issues.
- Definition Classes
- Consumer
-
def
postRestart(reason: Throwable): Unit
User overridable callback: By default it calls
preStart()
.User overridable callback: By default it calls
preStart()
.Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
- reason
the Throwable that caused the restart to happen Is called right AFTER restart on the newly created Actor to allow reinitialization after an Actor crash.
- Definition Classes
- UntypedActor → Actor
- Annotations
- @throws( classOf[Exception] )
-
def
postStop(): Unit
User overridable callback.
User overridable callback.
Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.
- Definition Classes
- UntypedActor → Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preRestart(reason: Throwable, message: Option[Any]): Unit
User overridable callback: By default it disposes of all children and then calls
postStop()
.User overridable callback: By default it disposes of all children and then calls
postStop()
.Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- reason
the Throwable that caused the restart to happen
- message
optionally the current message the actor processed when failing, if applicable Is called on a crashed Actor right BEFORE it is restarted to allow clean up of resources before Actor is terminated.
- Definition Classes
- UntypedActor → Actor
- Annotations
- @throws( classOf[Exception] )
-
def
preStart(): Unit
Registers the consumer endpoint.
-
final
def
receive: PartialFunction[Any, Unit]
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
Scala API: This defines the initial actor behavior, it must return a partial function with the actor logic.
- Definition Classes
- UntypedActor → Actor
-
def
replyTimeout: FiniteDuration
When endpoint is out-capable (can produce responses) replyTimeout is the maximum time the endpoint can take to send the response before the message exchange fails.
When endpoint is out-capable (can produce responses) replyTimeout is the maximum time the endpoint can take to send the response before the message exchange fails. It defaults to 1 minute. This setting is used for out-capable, in-only, manually acknowledged communication.
- Definition Classes
- Consumer
-
implicit final
val
self: ActorRef
The 'self' field holds the ActorRef for this actor.
The 'self' field holds the ActorRef for this actor.
Can be used to send messages to itself:
self ! message
- Definition Classes
- Actor
-
final
def
sender(): ActorRef
The reference sender Actor of the last received message.
The reference sender Actor of the last received message. Is defined if the message was sent from another Actor, else
deadLetters
in akka.actor.ActorSystem.WARNING: Only valid within the Actor itself, so do not close over it and publish it to other threads!
- Definition Classes
- Actor
-
def
supervisorStrategy: SupervisorStrategy
User overridable definition the strategy to use for supervising child actors.
User overridable definition the strategy to use for supervising child actors.
- Definition Classes
- UntypedActor → Actor
-
def
unhandled(message: Any): Unit
Recommended convention is to call this method if the message isn't handled in #onReceive (e.g.
Recommended convention is to call this method if the message isn't handled in #onReceive (e.g. unknown message type). By default it fails with either a akka.actor.DeathPactException (in case of an unhandled akka.actor.Terminated message) or publishes an akka.actor.UnhandledMessage to the actor's system's akka.event.EventStream.
- Definition Classes
- UntypedActor → Actor