Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package command
    Definition Classes
    csw
  • package client

    This project defines the basic classes and traits for the Command Service.

    Command Service

    This project defines the basic classes and traits for the Command Service.

    Related projects are: - csw-messages:

    • This defines the types of command (Oneway/Submit etc.) and types of configurations (Setup/Observe/Wait etc.)
    • Complete usage of Messages is available at: https://tmtsoftware.github.io/csw/services/messages.html

    - framework:

    • This defines the Hcd and Assembly handlers, lifecycle manager and supervisor for components.
    • Framework allows component writer to override onValidation, onSubmit and onOneway handlers. (Note it allows overriding other handlers as well.)
    • On every command received by component, onValidation handler gets invoked where received command gets validated and validation response is returned.
    • Based on validation response and command type, onSubmit/onOneway hooks gets invoked where command gets processed.
    • Complete details of handling commands can be found here : https://tmtsoftware.github.io/csw/framework/handling-lifecycle.html#handling-commands

    Important classes in this project are:

    - csw.command.api.scaladsl.CommandService

    This class wraps the csw.location.api.models.AkkaLocation and provides helpers to send commands to component actor extracted from provided location. Normal component writers workflow would be to first resolve component using location service and then create CommandService instance using resolved location.

    Using this instance, you can Submit Command/Commands to other component or query for command result or subscribe for long running command result.

    When you have multiple commands targeted to multiple components then you can use ConfigDistributor. Using CommandDistributor utility you can send all these commands in one go and get aggregated response.

    Complete guide of usage of different API's provided by CommandService is available at: https://tmtsoftware.github.io/csw/command.html

    Definition Classes
    command
  • package messages
    Definition Classes
    client
  • object CommandMessage
    Definition Classes
    messages
  • Oneway
  • Submit
  • Validate

case class Validate(command: ControlCommand, replyTo: ActorRef[ValidateResponse]) extends CommandMessage with Product with Serializable

Represents a validate only kind of message that carries command to other component

command

represents a command sent to other component

replyTo

represents the actor that will receive the command response

Linear Supertypes
Serializable, Product, Equals, CommandMessage, SupervisorLockMessage, RunningMessage, RemoteMsg, CommandSerializable, SupervisorRunningMessage, ComponentMessage, SupervisorMessage, TopLevelActorMessage, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Validate
  2. Serializable
  3. Product
  4. Equals
  5. CommandMessage
  6. SupervisorLockMessage
  7. RunningMessage
  8. RemoteMsg
  9. CommandSerializable
  10. SupervisorRunningMessage
  11. ComponentMessage
  12. SupervisorMessage
  13. TopLevelActorMessage
  14. AnyRef
  15. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Validate(command: ControlCommand, replyTo: ActorRef[ValidateResponse])

    command

    represents a command sent to other component

    replyTo

    represents the actor that will receive the command response

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. val command: ControlCommand

    Represents a command sent to other component

    Represents a command sent to other component

    Definition Classes
    Validate → CommandMessage
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def productElementNames: Iterator[String]
    Definition Classes
    Product
  14. val replyTo: ActorRef[ValidateResponse]

    Represents the actor that will receive the Locked response for Submit, Oneway and Validate kind of commands

    Represents the actor that will receive the Locked response for Submit, Oneway and Validate kind of commands

    Definition Classes
    Validate → CommandMessage
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CommandMessage

Inherited from SupervisorLockMessage

Inherited from RunningMessage

Inherited from RemoteMsg

Inherited from CommandSerializable

Inherited from SupervisorRunningMessage

Inherited from ComponentMessage

Inherited from SupervisorMessage

Inherited from TopLevelActorMessage

Inherited from AnyRef

Inherited from Any

Ungrouped