Packages

  • package root
    Definition Classes
    root
  • package csw
    Definition Classes
    root
  • package params

    This project is intended to hold reusable models and params used throughout the csw source code.

    Params

    This project is intended to hold reusable models and params used throughout the csw source code.

    This also provides out of the box support to cater to the diverse communication requirements. Consumer of this library will be able to create Commands, Events, States to store ParameterSets.

    Imp Packages

    Commands and Events

    This packages contains classes, traits and models used to create *commands* and *events*. These are all based on type-safe keys and items (a set of values with optional units). Each key has a specific type and the key's values must be of that type.

    Two types of csw.params.commands.Command are supported:

    Following are the concrete commands supported by csw:

    Two types of csw.params.events.Event are supported:

    core

    This package supports serialization and deserialization of commands, events and state variables in JSON format csw.params.core.formats.JsonSupport.

    Scala and Java APIs

    All the param and event classes are immutable. The set methods return a new instance of the object with a new item added and the get methods return an Option, in case the Key is not found. There are also value methods that return a value directly, throwing an exception if the key or value is not found.

    Key Types

    A set of standard key types and matching items are defined. Each key accepts one or more values of the given type.

    Following csw.params.core.generics.KeyType are supported by csw:

    +--------------+-------------------------+---------------------------+
|  Primitive   |      Scala KeyType      |       Java KeyType        |
+--------------+-------------------------+---------------------------+
| Boolean      | KeyType.BooleanKey      | JKeyType.BooleanKey      |
| Character    | KeyType.CharKey         | JKeyType.JCharKey        |
| Byte         | KeyType.ByteKey         | JKeyType.ByteKey         |
| Short        | KeyType.ShortKey        | JKeyType.ShortKey        |
| Long         | KeyType.LongKey         | JKeyType.LongKey         |
| Int          | KeyType.IntKey          | JKeyType.IntKey          |
| Float        | KeyType.FloatKey        | JKeyType.FloatKey        |
| Double       | KeyType.DoubleKey       | JKeyType.DoubleKey       |
| String       | KeyType.StringKey       | JKeyType.StringKey       |
| UtcTime      | KeyType.UTCTimeKey      | JKeyType.UTCTimeKey      |
| TaiTime      | KeyType.TAITimeKey      | JKeyType.TAITimeKey      |
| ----------   | ----------              | ----------               |
| ByteArray    | KeyType.ByteArrayKey    | JKeyType.ByteArrayKey    |
| ShortArray   | KeyType.ShortArrayKey   | JKeyType.ShortArrayKey   |
| LongArray    | KeyType.LongArrayKey    | JKeyType.LongArrayKey    |
| IntArray     | KeyType.IntArrayKey     | JKeyType.IntArrayKey     |
| FloatArray   | KeyType.FloatArrayKey   | JKeyType.FloatArrayKey   |
| DoubleArray  | KeyType.DoubleArrayKey  | JKeyType.DoubleArrayKey  |
| ----------   | ----------              | ----------               |
| ByteMatrix   | KeyType.ByteMatrixKey   | JKeyType.ByteMatrixKey   |
| ShortMatrix  | KeyType.ShortMatrixKey  | JKeyType.ShortMatrixKey  |
| LongMatrix   | KeyType.LongMatrixKey   | JKeyType.LongMatrixKey   |
| IntMatrix    | KeyType.IntMatrixKey    | JKeyType.IntMatrixKey    |
| FloatMatrix  | KeyType.FloatMatrixKey  | JKeyType.FloatMatrixKey  |
| DoubleMatrix | KeyType.DoubleMatrixKey | JKeyType.DoubleMatrixKey |
| ----------   | ----------              | ----------               |
| Choice       | KeyType.ChoiceKey       | JKeyType.ChoiceKey       |
| RaDec        | KeyType.RaDecKey        | JKeyType.RaDecKey        |
| Struct       | KeyType.StructKey       | JKeyType.StructKey       |
+--------------+-------------------------+---------------------------+

    Detailed information about creating Keys and Parameters can be found here: https://tmtsoftware.github.io/csw/services/messages/keys-parameters.html

    Detailed information about creating commands can be found here: https://tmtsoftware.github.io/csw/services/messages/commands.html

    Detailed information about creating events can be found here: https://tmtsoftware.github.io/csw/services/messages/events.html

    Definition Classes
    csw
  • package commands
    Definition Classes
    params
  • Command
  • CommandIssue
  • CommandList
  • CommandName
  • CommandResponse
  • ControlCommand
  • Keys
  • Nameable
  • Observe
  • Result
  • Sequence
  • SequenceCommand
  • Setup
  • Wait

object CommandResponse

The nature of CommandResponse as an intermediate response of command execution or a final response which could be positive or negative

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CommandResponse
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class Accepted(runId: Id) extends ValidateCommandResponse with ValidateResponse with OnewayResponse with Product with Serializable

    Represents a final response stating acceptance of a command received meaning passed validation

    Represents a final response stating acceptance of a command received meaning passed validation

    runId

    the runId of command for which this response is created

  2. case class Cancelled(runId: Id) extends SubmitResponse with Product with Serializable

    Represents a negative response that describes the cancellation of command

    Represents a negative response that describes the cancellation of command

    runId

    of command for which this response is created

  3. case class Completed(runId: Id, result: Result) extends SubmitResponse with MatchingResponse with Product with Serializable

    Represents a final positive response stating completion of command with no errors A result may be included or may be empty

    Represents a final positive response stating completion of command with no errors A result may be included or may be empty

    runId

    of command for which this response is created

    result

    describing the result of completion if needed

  4. case class Error(runId: Id, message: String) extends SubmitResponse with MatchingResponse with Product with Serializable

    Represents a negative response that describes an error in executing the command

    Represents a negative response that describes an error in executing the command

    runId

    of command for which this response is created

    message

    describing the reason or cause or action item of the error encountered while executing the command

  5. case class Invalid(runId: Id, issue: CommandIssue) extends ValidateCommandResponse with ValidateResponse with OnewayResponse with SubmitResponse with MatchingResponse with Product with Serializable

    Represents a final negative response invalidating a command received has failed validation

    Represents a final negative response invalidating a command received has failed validation

    runId

    of command for which this response is created

    issue

    describing the cause of invalidation

  6. case class Locked(runId: Id) extends ValidateResponse with OnewayResponse with SubmitResponse with MatchingResponse with Product with Serializable

    Represents a negative response stating that a component is Locked and command was not validated or executed

    Represents a negative response stating that a component is Locked and command was not validated or executed

    runId

    of command for which this response is created

  7. sealed trait MatchingResponse extends CommandResponse

    MatchingResponse is returned by matchers.

    MatchingResponse is returned by matchers. Responses returned can be Invalid, Completed, Error, Locked

  8. sealed trait OnewayResponse extends CommandResponse

    OnewayResponse is returned by Oneway message which calls the onOneway handler Responses returned can be Accepted, Invalid, Locked

  9. case class Started(runId: Id) extends SubmitResponse with Product with Serializable

    Represents a preliminary response stating a long running command has been started

    Represents a preliminary response stating a long running command has been started

    runId

    of command for which this response is created

  10. sealed trait SubmitResponse extends CommandResponse

    SubmitResponse is returned by Submit message which calls the onSubmit handler Responses returned can be Invalid, Started, Completed, Error, Cancelled, Locked

  11. sealed trait ValidateCommandResponse extends CommandResponse

    ValidationResponse is returned by validateCommand handler.

    ValidationResponse is returned by validateCommand handler. Values can only be Invalid, Accepted

  12. sealed trait ValidateResponse extends CommandResponse

    ValidateOnlyResponse is returned by Validate message, which calls validateCommand handler Values can be Invalid, Accepted, Locked.

    ValidateOnlyResponse is returned by Validate message, which calls validateCommand handler Values can be Invalid, Accepted, Locked. Since the component can be locked, it is ValidationResponse with Locked

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. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def isFinal(sr: SubmitResponse): Boolean

    Tests a response to determine if it is a final command state

    Tests a response to determine if it is a final command state

    sr

    response for testing

    returns

    true if it is final

  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def isIntermediate(sr: SubmitResponse): Boolean

    Tests a response to determine if it is an intermediate response

    Tests a response to determine if it is an intermediate response

    sr

    response for testing

    returns

    returns true if it is intermediate

  13. def isNegative(sr: SubmitResponse): Boolean

    Tests a response to determine if it is a negative response

    Tests a response to determine if it is a negative response

    sr

    response for testing

    returns

    true if it is negative

  14. def isPositive(or: OnewayResponse): Boolean

    Test a OnewayResponse to determine if it is a positive response

    Test a OnewayResponse to determine if it is a positive response

    or

    a OnewayResponse for testing

    returns

    true if positive, false otherwise

  15. def isPositive(sr: SubmitResponse): Boolean

    Test a response to determine if it is a positive response

    Test a response to determine if it is a positive response

    sr

    response for testing

    returns

    true if it is positive

  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. object Completed extends Serializable

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped