csw.framework.javadsl

Class JComponentHandlers

java.lang.Object

csw.framework.scaladsl.ComponentHandlers

csw.framework.javadsl.JComponentHandlers

public abstract class JComponentHandlers
extends csw.framework.scaladsl.ComponentHandlers

Base class for component handlers which will be used by the component actor

param: ctx the ActorContext under which the actor instance of the component, which use these handlers, is created param: cswCtx provides access to csw services e.g. location, event, alarm, etc

Constructor Summary

Constructors

Constructor and Description
JComponentHandlers(akka.actor.typed.javadsl.ActorContext<TopLevelActorMessage> ctx, JCswContext cswCtx)

Method Summary

Modifier and Type	Method and Description
scala.concurrent.ExecutionContextExecutor	ec()
scala.concurrent.Future<scala.runtime.BoxedUnit>	initialize() Invokes the java helper (jInitialize) to initialize the component
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	jInitialize() A Java helper that is invoked when the component is created.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	jOnShutdown() The onShutdown handler can be used for carrying out the tasks which will allow the component to shutdown gracefully
scala.concurrent.Future<scala.runtime.BoxedUnit>	onShutdown() Invokes the java helper (jOnShutdown) to shutdown the component

Methods inherited from class csw.framework.scaladsl.ComponentHandlers

isOnline_$eq, isOnline, onGoOffline, onGoOnline, onLocationTrackingEvent, onOneway, onSubmit, trackConnection, validateCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JComponentHandlers

public JComponentHandlers(akka.actor.typed.javadsl.ActorContext<TopLevelActorMessage> ctx,
                          JCswContext cswCtx)

Method Detail

ec

public scala.concurrent.ExecutionContextExecutor ec()

initialize

public scala.concurrent.Future<scala.runtime.BoxedUnit> initialize()

Invokes the java helper (jInitialize) to initialize the component

Specified by:

initialize in class csw.framework.scaladsl.ComponentHandlers

Returns:

a future which completes when jInitialize completes

jInitialize

public abstract java.util.concurrent.CompletableFuture<java.lang.Void> jInitialize()

A Java helper that is invoked when the component is created. This is different than constructor initialization to allow non-blocking asynchronous operations. The component can initialize state such as configuration to be fetched from configuration service, location of components or services to be fetched from location service etc. These vary from component to component.

Returns:

a CompletableFuture which completes when the initialization of component completes

jOnShutdown

public abstract java.util.concurrent.CompletableFuture<java.lang.Void> jOnShutdown()

The onShutdown handler can be used for carrying out the tasks which will allow the component to shutdown gracefully

Returns:

a CompletableFuture which completes when the shutdown completes for component

onShutdown

public scala.concurrent.Future<scala.runtime.BoxedUnit> onShutdown()

Invokes the java helper (jOnShutdown) to shutdown the component

Specified by:

onShutdown in class csw.framework.scaladsl.ComponentHandlers

Returns:

a future which completes when the jOnShutdown completes