package alarm

package auth

package command

package config

package database

package event

package framework

This project contains the framework for creating components, such as HCDs and Assemblies.

Framework

This project contains the framework for creating components, such as HCDs and Assemblies.

A component is implemented by extending the csw.framework.scaladsl.ComponentHandlers base class. These handlers are executed under an Supervisor Actor: csw.framework.internal.supervisor.SupervisorBehavior and TLA Actor (Top Level Actor): csw.framework.internal.component.ComponentBehavior defined in the framework which handles the lifecycle and supervision of this component.

Components are controlled by a csw.framework.internal.supervisor.SupervisorBehavior actor that intercepts common messages (ex. Shutdown, Restart) or lifecycle messages (ex. GoOffline or GoOnline) sent from external entities to determine the state of the component.

Components that are not in the csw.command.client.models.framework.SupervisorLifecycleState.Running state, do not receive csw.params.CommandMessage.

When Component is created using this framework, it guarantees that component (HCD/Assembly) is registered with LocationService only when Component moves to csw.command.client.models.framework.SupervisorLifecycleState.Running state. That means, one component can resolve other component only when its in Running state and ready to accept params.CommandMessage

Important Actors in Framework

- csw.framework.internal.supervisor.SupervisorBehavior : Each component created by this framework is supervised by this actor.

Default strategy of supervisor is to stop child actor but depending on nature of the failure, the supervisor has a choice of the following two options:

csw.framework.exceptions.FailureRestart : Restart the child actor i.e. kill the current child actor that failed and create a new one in its place
csw.framework.exceptions.FailureStop : Stop the child actor permanently

Supervisor changes its csw.command.client.models.framework.SupervisorLifecycleState based on the messages it receives. Decision to handle external messages or not is taken by the supervisor based on its current csw.command.client.models.framework.SupervisorLifecycleState. For complete list of supported messages per csw.command.client.models.framework.SupervisorLifecycleState, see csw-messages project.

- csw.framework.internal.component.ComponentBehavior : Like Supervisor, evey component is associate with this actor which is known as TLA (Top Level Actor) And it also maintains its own state csw.framework.internal.component.ComponentLifecycleState based on messages it receives.

Main purpose of this actor is to invoke component specific code written in their corresponding handlers. This is where framework code meets Component specific code.

- csw.framework.internal.pubsub.PubSubBehavior : This actor is created by framework which is wrapped into csw.framework.CurrentStatePublisher for easy interaction with this actor and then passed to component handlers so that component can publish their csw.params.core.states.CurrentState.

If one component (ex. Assembly) is interested in csw.params.core.states.CurrentState published by other component (ex. HCD) then Assembly can subscribe to HCD's current state.

PubSub actor maintains the list of subscribers and keeps publishing csw.params.core.states.CurrentState to all subscribers.

- csw.framework.internal.container.ContainerBehavior : When multiple components needs to be started in container, then this actor is created. Job of this actor is just to logically group multiple components and support csw.params.SupervisorContainerCommonMessages. It receives csw.params.SupervisorContainerCommonMessages.Shutdown or csw.params.SupervisorContainerCommonMessages.Restart message and forwards it to all the components residing in this container.

deploy package

- csw.framework.deploy.containercmd.ContainerCmd : ContainerCmd is a helper utility provided by framework to start multiple components in container mode or single component in Standalone mode.

Example of Container Config File

Here is an example of a config file for creating a container with the name IRIS_Container that contains one assembly (named Filter) and depends on the services of two HCDs (Instrument_Filter and Disperser). Factory class for assembly is csw.common.components.framework.SampleComponentBehaviorFactory. A Supervisor actor will be created to manage the assembly, which includes registering it with the location service, using the given name and prefix. The prefix can be used to distribute parts of the configurations to different HCDs. HCDs register themselves with the Location Service and specify a unique prefix that can be used for this purpose.

name = "IRIS_Container"
components: [
  {
    name = "Filter"
    componentType = assembly
    behaviorFactoryClassName = csw.common.components.framework.SampleComponentBehaviorFactory
    prefix = tcs.mobie.blue.filter
    locationServiceUsage = RegisterOnly
    connections = [
      {
        name: Instrument_Filter
        componentType: hcd
        connectionType: akka
      },
      {
        name: Disperser
        componentType: hcd
        connectionType: akka
      }
    ]
  },
  {
    name = "Instrument_Filter"
    componentType = hcd
    behaviorFactoryClassName = csw.common.components.framework.SampleComponentBehaviorFactory
    prefix = tcs.mobie.blue.filter
    locationServiceUsage = RegisterOnly
  },
  {
    name = "Disperser"
    componentType: hcd
    behaviorFactoryClassName: csw.common.components.framework.SampleComponentBehaviorFactory
    prefix: tcs.mobie.blue.disperser
    locationServiceUsage = RegisterOnly
  }
]

Example of Standalone Config File

name = "IFS_Detector"
componentType = hcd
behaviorFactoryClassName = csw.common.components.framework.SampleComponentBehaviorFactory
prefix = iris.ifs
locationServiceUsage = RegisterOnly
connections = []

- csw.framework.deploy.hostconfig.HostConfig : This is just a helper to create host configuration application. This support starting multiple containers on a given host machine and each container will have single/multiple components.

Example of Host Config file

# This is a host configuration file which contains list of containers to be spawned by host configuration app
containers: [
    {
      # mode can be one of Container or Standalone
      mode: "Container"
      # path of individual container configuration file
      configFilePath: "/resources/assemblyContainer.conf"
      # provide 'Remote' if file needs to fetched from config service else
      # provide 'Local' to fetch file from local machine
      configFileLocation: "Local"
    },
    {
      mode: "Standalone"
      configFilePath: "/resources/hcdStandalone.conf"
      configFileLocation: "Local"
    }
]

package location

package logging

This is a Actor based logging library which supports writing logs to File and StdOut Console.

Logging Service

This is a Actor based logging library which supports writing logs to File and StdOut Console.

Features

Supports component specific log levels, ex. HCD1 can choose to log at info level and HCD2 can choose to log at debug level
Supports dynamically changing component log levels
Asynchronous thread safe logging
Structured logging
Supports overriding default logging properties per component viz
Intercepting logs from akka/slf4j
Supports JSON logging

LogActor

LogActor is the heart of logging library. It receives messages from following classes:

Slf4jAppender: Intercepts Slf4j logs and forwards it to LogActor via MessageHandler
AkkaLogger: Intercepts Akka logs and forwards it to LogActor via MessageHandler.
LoggerImpl: Provides csw logging API for component writer to log messages which gets forwarded to LogActor via MessageHandler

Logging Appenders

This library supports two types of csw.logging.appenders.LogAppender:

csw.logging.appenders.FileAppender: Common log messages are written in Pretty Json form. This appender is useful during development. It is recommended to disable it in production.
csw.logging.appenders.StdOutAppender: Log messages are written as Json, one per line. Ordinary log messages are written to the common log files. Each log file includes a day as part of its name. Each day a new file is created.

You can specify the appender in application.conf file as shown below:

csw-logging {
   appenders = ["csw.logging.appenders.StdOutAppender$", "csw.logging.appenders.FileAppender$"]
 }

Component Specific Log Levels

For each component, ComponentLoggingState instance gets created which maintains log levels which are enabled and disabled for this particular component. Every time message gets logged by component, LoggerImpl checks in corresponding componentLoggingState whether current log level enabled or not. If enabled, then only log message gets forwarded to LogActor via MessageHandler.

You can specify the component specific log levels in application.conf file as shown below:

component-log-levels {
   tromboneHcd = debug
   tromboneAssembly = error
}

̄ Detailed documentation of Logging Service is available at: https://tmtsoftware.github.io/csw/services/logging.html

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:

csw.params.commands.SequenceCommand
- This commands are targeted to Sequencer. Subtypes of this are: Setup, Observe and Wait.
csw.params.commands.ControlCommand
- This commands are targeted to Assemblies and HCD's. Subtypes of this are: Setup and Observe.

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      | JKeyTypes.BooleanKey      |
| Character    | KeyType.CharKey         | JKeyTypes.JCharKey        |
| Byte         | KeyType.ByteKey         | JKeyTypes.ByteKey         |
| Short        | KeyType.ShortKey        | JKeyTypes.ShortKey        |
| Long         | KeyType.LongKey         | JKeyTypes.LongKey         |
| Int          | KeyType.IntKey          | JKeyTypes.IntKey          |
| Float        | KeyType.FloatKey        | JKeyTypes.FloatKey        |
| Double       | KeyType.DoubleKey       | JKeyTypes.DoubleKey       |
| String       | KeyType.StringKey       | JKeyTypes.StringKey       |
| Timestamp    | KeyType.TimestampKey    | JKeyTypes.TimestampKey    |
| ----------   | ----------              | ----------                |
| ByteArray    | KeyType.ByteArrayKey    | JKeyTypes.ByteArrayKey    |
| ShortArray   | KeyType.ShortArrayKey   | JKeyTypes.ShortArrayKey   |
| LongArray    | KeyType.LongArrayKey    | JKeyTypes.LongArrayKey    |
| IntArray     | KeyType.IntArrayKey     | JKeyTypes.IntArrayKey     |
| FloatArray   | KeyType.FloatArrayKey   | JKeyTypes.FloatArrayKey   |
| DoubleArray  | KeyType.DoubleArrayKey  | JKeyTypes.DoubleArrayKey  |
| ----------   | ----------              | ----------                |
| ByteMatrix   | KeyType.ByteMatrixKey   | JKeyTypes.ByteMatrixKey   |
| ShortMatrix  | KeyType.ShortMatrixKey  | JKeyTypes.ShortMatrixKey  |
| LongMatrix   | KeyType.LongMatrixKey   | JKeyTypes.LongMatrixKey   |
| IntMatrix    | KeyType.IntMatrixKey    | JKeyTypes.IntMatrixKey    |
| FloatMatrix  | KeyType.FloatMatrixKey  | JKeyTypes.FloatMatrixKey  |
| DoubleMatrix | KeyType.DoubleMatrixKey | JKeyTypes.DoubleMatrixKey |
| ----------   | ----------              | ----------                |
| Choice       | KeyType.ChoiceKey       | JKeyTypes.ChoiceKey       |
| RaDec        | KeyType.RaDecKey        | JKeyTypes.RaDecKey        |
| Struct       | KeyType.StructKey       | JKeyTypes.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

package serializable

package services

package testkit

Packages

Framework

Important Actors in Framework

deploy package

Example of Container Config File

Example of Standalone Config File

Example of Host Config file

Logging Service

Features

LogActor

Logging Appenders

Component Specific Log Levels

Params

Imp Packages

Commands and Events

core

Scala and Java APIs

Key Types

csw

package csw

Ungrouped

Packages

Framework

Important Actors in Framework

deploy package

Example of Container Config File

Example of Standalone Config File

Example of Host Config file

Logging Service

Features

LogActor

Logging Appenders

Component Specific Log Levels

Params

Imp Packages

Commands and Events

core

Scala and Java APIs

Key Types

csw 

package csw

Ungrouped

csw