Package org.yamcs.client

Class Command

java.lang.Object

org.yamcs.client.Command

All Implemented Interfaces:

Comparable<Command>

public class Command
extends Object
implements Comparable<Command>

Constructor Summary

Constructors

Constructor	Description
Command(String id, String name, Map<String,String> aliases, List<Commanding.CommandAssignment> assignments, String origin, int sequenceNumber, Instant generationTime)
Command(Commanding.CommandHistoryEntry entry)
Command(IssueCommandResponse response)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Command other)
boolean	equals(Object obj)
Acknowledgment	getAcknowledgment(String name)
LinkedHashMap<String,Acknowledgment>	getAcknowledgments()	All acknowledgments by name
List<Commanding.CommandAssignment>	getAssignments()
<T> T	getAttribute(String key)
Map<String,Object>	getAttributes()	Returns all attributes of this commands.
byte[]	getBinary()	Binary representation of the command
Map<String,Command>	getCascadedRecords()	Returns command records that capture state of upstream (cascaded) servers.
String	getComment()
String	getError()	Error message in case this command failed
LinkedHashMap<String,Object>	getExtraAttributes()	Returns non-standard attributes
Instant	getGenerationTime()
String	getId()
String	getName()	Fully qualified command name
String	getName(String namespace)	Alias under the specified namespace.
String	getOrigin()
String	getQueue()	The assigned command queue
Acknowledgment	getQueuedAcknowledgment()
Acknowledgment	getReleasedAcknowledgment()
Acknowledgment	getSentAcknowledgment()
int	getSequenceNumber()
String	getSource()	String representation of the command
byte[]	getUnprocessedBinary()	Unprocessed binary representation of the command (prior to postprocessing).
String	getUsername()	Username of the issuer
int	hashCode()
boolean	isComplete()	Returns whether this command is complete.
boolean	isFailure()	Returns true if this command failed
boolean	isSuccess()	Returns true if this command has completed successfully
void	merge(Command other)
void	merge(Commanding.CommandHistoryEntry entry)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Command

public Command(String id,
 String name,
 Map<String,String> aliases,
 List<Commanding.CommandAssignment> assignments,
 String origin,
 int sequenceNumber,
 Instant generationTime)

Command

public Command(IssueCommandResponse response)

Command

public Command(Commanding.CommandHistoryEntry entry)

Method Details

getId

public String getId()

getGenerationTime

public Instant getGenerationTime()

getName

public String getName()

Fully qualified command name

getName

public String getName(String namespace)

Alias under the specified namespace. Returns null if this command has no such alias.

getAssignments

public List<Commanding.CommandAssignment> getAssignments()

getOrigin

public String getOrigin()

getSequenceNumber

public int getSequenceNumber()

getUsername

public String getUsername()

Username of the issuer

getQueue

public String getQueue()

The assigned command queue

getSource

public String getSource()

String representation of the command

getUnprocessedBinary

public byte[] getUnprocessedBinary()

Unprocessed binary representation of the command (prior to postprocessing).

getBinary

public byte[] getBinary()

Binary representation of the command

getAttribute

public <T> T getAttribute(String key)

isComplete

public boolean isComplete()

Returns whether this command is complete. A command can be complete, yet still failed.

isSuccess

public boolean isSuccess()

Returns true if this command has completed successfully

isFailure

public boolean isFailure()

Returns true if this command failed

getError

public String getError()

Error message in case this command failed

getComment

public String getComment()

getAttributes

public Map<String,Object> getAttributes()

Returns all attributes of this commands.

merge

public void merge(Commanding.CommandHistoryEntry entry)

merge

public void merge(Command other)

getExtraAttributes

public LinkedHashMap<String,Object> getExtraAttributes()

Returns non-standard attributes

getAcknowledgments

public LinkedHashMap<String,Acknowledgment> getAcknowledgments()

All acknowledgments by name

getQueuedAcknowledgment

public Acknowledgment getQueuedAcknowledgment()

getReleasedAcknowledgment

public Acknowledgment getReleasedAcknowledgment()

getSentAcknowledgment

public Acknowledgment getSentAcknowledgment()

getAcknowledgment

public Acknowledgment getAcknowledgment(String name)

getCascadedRecords

public Map<String,Command> getCascadedRecords()

Returns command records that capture state of upstream (cascaded) servers.

The returned map is keyed by the cascading prefix, for example: yamcs<SERVER1>_ when the information is cascaded from SERVER1, or yamcs<SERVER2>_yamcs<SERVER1>_ when the information is cascaded from SERVER 1 over SERVER2.

compareTo

public int compareTo(Command other)

Specified by:

compareTo in interface Comparable<Command>

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object