akka.camel.javaapi

UntypedConsumerActor

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.

Source
UntypedConsumerActor.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. UntypedConsumerActor
  2. Consumer
  3. CamelSupport
  4. UntypedActor
  5. Actor
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new UntypedConsumerActor()

Type Members

  1. type Receive = PartialFunction[Any, Unit]

    Definition Classes
    Actor

Abstract Value Members

  1. abstract def getEndpointUri(): String

    Java API: Returns the Camel endpoint URI to consume messages from.

  2. 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[Exception] )

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (UntypedConsumerActor, B)

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to ArrowAssoc[UntypedConsumerActor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. 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
  9. def aroundPostRestart(reason: Throwable): Unit

    Can be overridden to intercept calls to postRestart.

    Can be overridden to intercept calls to postRestart. Calls postRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  10. def aroundPostStop(): Unit

    Can be overridden to intercept calls to postStop.

    Can be overridden to intercept calls to postStop. Calls postStop by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  11. def aroundPreRestart(reason: Throwable, message: Option[Any]): Unit

    Can be overridden to intercept calls to preRestart.

    Can be overridden to intercept calls to preRestart. Calls preRestart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  12. def aroundPreStart(): Unit

    Can be overridden to intercept calls to preStart.

    Can be overridden to intercept calls to preStart. Calls preStart by default.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  13. def aroundReceive(receive: actor.Actor.Receive, msg: Any): Unit

    INTERNAL API.

    INTERNAL API.

    Can be overridden to intercept calls to this actor's current behavior.

    receive

    current behavior.

    msg

    current message.

    Attributes
    protected[akka]
    Definition Classes
    Actor
  14. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  15. 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
  16. val camel: Camel

    INTERNAL API Returns a akka.camel.Camel trait which provides access to the CamelExtension.

    INTERNAL API Returns a akka.camel.Camel trait which provides access to the CamelExtension.

    Attributes
    protected
    Definition Classes
    CamelSupport
  17. implicit def camelContext: DefaultCamelContext

    Returns the CamelContext.

    Returns the CamelContext. The camelContext is defined implicit for simplifying the use of CamelMessage from the Scala API.

    Attributes
    protected
    Definition Classes
    CamelSupport
  18. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. implicit val context: ActorContext

    Stores the context for this actor, including self, and sender.

    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.UntypedActorContext, which is the Java API of the actor context.

    Definition Classes
    Actor
  20. 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
    UntypedConsumerActorConsumer
  21. def ensuring(cond: (UntypedConsumerActor) ⇒ Boolean, msg: ⇒ Any): UntypedConsumerActor

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to Ensuring[UntypedConsumerActor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. def ensuring(cond: (UntypedConsumerActor) ⇒ Boolean): UntypedConsumerActor

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to Ensuring[UntypedConsumerActor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  23. def ensuring(cond: Boolean, msg: ⇒ Any): UntypedConsumerActor

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to Ensuring[UntypedConsumerActor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  24. def ensuring(cond: Boolean): UntypedConsumerActor

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to Ensuring[UntypedConsumerActor] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  25. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  27. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  28. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  29. def getActivation(): Activation

    Java API: Returns the akka.camel.Activation interface that can be used to wait on activation or de-activation of Camel endpoints.

    Java API: Returns the akka.camel.Activation interface that can be used to wait on activation or de-activation of Camel endpoints.

    returns

    the Activation interface

    Attributes
    protected
  30. def getCamelContext(): DefaultCamelContext

    Java API: Returns the org.apache.camel.impl.DefaultCamelContext

    Java API: Returns the org.apache.camel.impl.DefaultCamelContext

    returns

    the CamelContext

    Attributes
    protected
  31. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  32. 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
  33. def getProducerTemplate(): ProducerTemplate

    Java API: Returns the org.apache.camel.ProducerTemplate

    Java API: Returns the org.apache.camel.ProducerTemplate

    returns

    the ProducerTemplate

    Attributes
    protected
  34. 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
  35. def getSelf(): ActorRef

    Returns the ActorRef for this actor.

    Returns the ActorRef for this actor.

    Definition Classes
    UntypedActor
  36. 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
  37. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  38. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  39. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  40. final def notify(): Unit

    Definition Classes
    AnyRef
  41. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  42. 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
  43. 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
    UntypedActorActor
    Annotations
    @throws( classOf[Exception] )
  44. def postStop(): Unit

    User overridable callback.

    User overridable callback.

    Is called asynchronously after 'actor.stop()' is invoked. Empty default implementation.

    Definition Classes
    UntypedActorActor
    Annotations
    @throws( classOf[Exception] )
  45. 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
    UntypedActorActor
    Annotations
    @throws( classOf[Exception] )
  46. def preStart(): Unit

    Registers the consumer endpoint.

    Registers the consumer endpoint. Note: when overriding this method, be sure to call 'super.preRestart', otherwise the consumer endpoint will not be registered.

    Definition Classes
    ConsumerActor
  47. final def receive: PartialFunction[Any, Unit]

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    This defines the initial actor behavior, it must return a partial function with the actor logic.

    Definition Classes
    UntypedActorActor
  48. 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
  49. 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
  50. 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
  51. 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
    UntypedActorActor
  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  53. def toString(): String

    Definition Classes
    AnyRef → Any
  54. def unhandled(message: Any): Unit

    Recommended convention is to call this method if the message isn't handled in #onReceive (e.

    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
    UntypedActorActor
  55. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def [B](y: B): (UntypedConsumerActor, B)

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to ArrowAssoc[UntypedConsumerActor] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (untypedConsumerActor: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (untypedConsumerActor: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: UntypedConsumerActor

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to ArrowAssoc[UntypedConsumerActor] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (untypedConsumerActor: ArrowAssoc[UntypedConsumerActor]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: UntypedConsumerActor

    Implicit information
    This member is added by an implicit conversion from UntypedConsumerActor to Ensuring[UntypedConsumerActor] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (untypedConsumerActor: Ensuring[UntypedConsumerActor]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Consumer

Inherited from CamelSupport

Inherited from UntypedActor

Inherited from Actor

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from UntypedConsumerActor to StringAdd

Inherited by implicit conversion any2stringfmt from UntypedConsumerActor to StringFormat

Inherited by implicit conversion any2ArrowAssoc from UntypedConsumerActor to ArrowAssoc[UntypedConsumerActor]

Inherited by implicit conversion any2Ensuring from UntypedConsumerActor to Ensuring[UntypedConsumerActor]

Ungrouped