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.client.CommandResponseManager

    This class wraps CommandResponseManagerActor and provides helpers to interact with actor which is responsible for adding/updating/querying command result. Component writers will get handle to CommandResponseManager in their handlers.

    - CommandResponseManagerActor maintains four states:

    - csw.command.api.scaladsl.CommandService

    This class wraps the csw.location.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 cbor
    Definition Classes
    client
  • package extensions
    Definition Classes
    client
  • package internal
    Definition Classes
    client
  • package messages
    Definition Classes
    client
  • package models
    Definition Classes
    client
  • CRMCacheProperties
  • CommandResponseManager
  • CommandResponseManagerActor
  • CommandServiceFactory
  • HttpCommandService
  • ICommandServiceFactory
  • SequencerCommandServiceFactory
  • Store

case class Store[K, V](map: Map[K, Set[V]]) extends Product with Serializable

Store represents the storage of a set of values against a given key

K

type of the key

V

type of the value

map

initial store map

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Store
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Store(map: Map[K, Set[V]])

    map

    initial store map

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. def addOrUpdate(key: K, value: V): Store[K, V]

    Add or update the value in the store against the given key

    Add or update the value in the store against the given key

    key

    key of the store

    value

    value against the key

    returns

    updated store after adding/update value

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def get(key: K): Set[V]

    Get the set of values against the given key.

    Get the set of values against the given key. If the key is not present then empty set would be returned

    key

    get the values against the given key

    returns

    set of values or empty set if key is not present

  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. val map: Map[K, Set[V]]
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. def remove(value: V): Store[K, V]

    Remove the value from the store.

    Remove the value from the store. The value could be present against multiple keys and it will be removed from all places.

    value

    value to be removed from the store

    returns

    updated store after removing the value

  17. def remove(key: K, value: V): Store[K, V]

    Remove the value from the store against the given key

    Remove the value from the store against the given key

    key

    key of the store

    value

    value to be removed against the key

    returns

    updated store after removing the value

  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped