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, completion of command, caching responses for command, etc. param: actorSystem actor system for managing stream resources inside

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
akka.actor.typed.ActorSystem<?>	actorSystem()
void	addOrUpdateCommand(CommandResponse.SubmitResponse cmdStatus)	Add a new command or update an existing command with the provided status
void	addSubCommand(Id parentRunId, Id childRunId)	Add a new sub command against another command
akka.actor.typed.ActorRef<CommandResponseManagerMessage>	commandResponseManagerActor()
java.util.concurrent.CompletableFuture<CommandResponse.QueryResponse>	jQuery(Id runId, akka.util.Timeout timeout)	A helper method for Java to query the current status of a command
java.util.concurrent.CompletableFuture<CommandResponse.SubmitResponse>	jQueryFinal(Id runId, akka.util.Timeout timeout)	A helper method for java to query the final status of a command
scala.concurrent.Future<CommandResponse.QueryResponse>	query(Id runId, akka.util.Timeout timeout)	Query the current status of a command
scala.concurrent.Future<CommandResponse.SubmitResponse>	queryFinal(Id runId, akka.util.Timeout timeout)	Query the final status of a command
void	updateSubCommand(CommandResponse.SubmitResponse cmdStatus)	Update the status of a sub-command which will infer the status of the parent command

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<CommandResponseManagerMessage> commandResponseManagerActor,
                              akka.actor.typed.ActorSystem<?> actorSystem)

Method Detail

actorSystem

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

addOrUpdateCommand

public void addOrUpdateCommand(CommandResponse.SubmitResponse cmdStatus)

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

Parameters:

cmdStatus - status of command as CommandResponse.SubmitResponse

addSubCommand

public void addSubCommand(Id parentRunId,
                          Id childRunId)

Add a new sub command against another command

Parameters:

parentRunId - command identifier of original command

childRunId - command identifier of sub command

commandResponseManagerActor

public akka.actor.typed.ActorRef<CommandResponseManagerMessage> commandResponseManagerActor()

jQuery

public java.util.concurrent.CompletableFuture<CommandResponse.QueryResponse> jQuery(Id runId,
                                                                                    akka.util.Timeout timeout)

A helper method for Java to query the current status of a command

Parameters:

runId - command identifier of command

timeout - timeout duration until which this operation is expected to wait for providing a value

Returns:

a future of CommandResponse

jQueryFinal

public java.util.concurrent.CompletableFuture<CommandResponse.SubmitResponse> jQueryFinal(Id runId,
                                                                                          akka.util.Timeout timeout)

A helper method for java to query the final status of a command

Parameters:

runId - command identifier of command

timeout - timeout duration until which this operation is expected to wait for providing a value

Returns:

a CompletableFuture of CommandResponse

query

public scala.concurrent.Future<CommandResponse.QueryResponse> query(Id runId,
                                                                    akka.util.Timeout timeout)

Query the current status of a command

Parameters:

runId - command identifier of command

timeout - timeout duration until which this operation is expected to wait for providing a value

Returns:

a future of CommandResponse

queryFinal

public scala.concurrent.Future<CommandResponse.SubmitResponse> queryFinal(Id runId,
                                                                          akka.util.Timeout timeout)

Query the final status of a command

Parameters:

runId - command identifier of command

timeout - timeout duration until which this operation is expected to wait for providing a value

Returns:

a future of CommandResponse

updateSubCommand

public void updateSubCommand(CommandResponse.SubmitResponse cmdStatus)

Update the status of a sub-command which will infer the status of the parent command

Parameters:

cmdStatus - status of command as CommandResponse.SubmitResponse