Package csw.command.client

Class CommandResponseManager

java.lang.Object

csw.command.client.CommandResponseManager

public class CommandResponseManager
extends java.lang.Object

Wrapper API for interacting with Command Response Manager of a component

param: commandResponseManagerActor underlying actor managing command responses for started commands param: actorSystem actor system for allowing sending messages in API

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandResponseManager.OverallFailure	Indicates that at least one of the responses ended with a negative response param: responses the set of responses
static class	CommandResponseManager.OverallFailure$
static interface	CommandResponseManager.OverallResponse
static class	CommandResponseManager.OverallSuccess	Indicates that all responses included completed successfully.
static class	CommandResponseManager.OverallSuccess$

Constructor Summary

Constructors

Constructor	Description
CommandResponseManager(akka.actor.typed.ActorRef<MiniCRM.CRMMessage> commandResponseManagerActor, akka.actor.typed.ActorSystem<?> actorSystem)

Method Summary

Modifier and Type	Method	Description
akka.actor.typed.ActorSystem<?>	actorSystem()
akka.actor.typed.ActorRef<MiniCRM.CRMMessage>	commandResponseManagerActor()
scala.concurrent.ExecutionContext	ex()
scala.concurrent.Future<CommandResponseManager.OverallResponse>	queryFinalAll(scala.collection.immutable.Seq<scala.concurrent.Future<CommandResponse.SubmitResponse>> commands)	queryFinal allows executing code when all the provided commands have completed.
void	updateCommand(CommandResponse.SubmitResponse submitResponse)	Add a new command or update an existing command with the provided status

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandResponseManager

public CommandResponseManager(akka.actor.typed.ActorRef<MiniCRM.CRMMessage> commandResponseManagerActor,
                              akka.actor.typed.ActorSystem<?> actorSystem)

Method Detail

commandResponseManagerActor

public akka.actor.typed.ActorRef<MiniCRM.CRMMessage> commandResponseManagerActor()

actorSystem

public akka.actor.typed.ActorSystem<?> actorSystem()

updateCommand

public void updateCommand(CommandResponse.SubmitResponse submitResponse)

Add a new command or update an existing command with the provided status

Parameters:

submitResponse - final update for a started command CommandResponse.SubmitResponse

ex

public scala.concurrent.ExecutionContext ex()

queryFinalAll

public scala.concurrent.Future<CommandResponseManager.OverallResponse> queryFinalAll(scala.collection.immutable.Seq<scala.concurrent.Future<CommandResponse.SubmitResponse>> commands)

queryFinal allows executing code when all the provided commands have completed.

Parameters:

commands - commands that have been started with submit or submitAndWait

Returns:

An overall response indicated success or failure