- getAgentProperty(String) - Method in class org.lsst.ccs.bus.data.AgentInfo
-
Get the value of the property for this Agent.
- getAgents() - Method in class org.lsst.ccs.bus.data.CCSVersions
-
Get the Set of AgentInfo contained in this class.
- getAlertId() - Method in class org.lsst.ccs.bus.data.Alert
-
Get the Alert id
- getAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance
-
The AlertState at which the RaisedAlertInstance was raised.
- getAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary
-
Get the overall AlertState for this RaisedAlarm summary object .
- getAllParameterInfo() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Returns a list of ConfigurationParameterInfo.
- getAllRaisedAlertHistories() - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary
-
Get the set of raised Alerts.
- getBasicCommand() - Method in class org.lsst.ccs.bus.messages.CommandRequest
-
Utility method to get the embedded BasicCommand.
- getBuildId() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getBuildJdk() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getBuildNumber() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getBuildUrl() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getCategoryName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
The category the parameter belongs to.
- getCategorySet() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
- getCause() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance
-
What caused this alert to be raised.
- getCause() - Method in class org.lsst.ccs.bus.messages.StatusRaisedAlert
-
Get the String explaining what caused the Alert.
- getClassName() - Method in class org.lsst.ccs.bus.messages.BusMessage
-
Get the class name of the embedded object.
- getClearAlertIds() - Method in class org.lsst.ccs.bus.messages.StatusClearedAlert
-
Get the String array of the alertIds that have been cleared.
- getComponentName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
Returns the name of the component the parameter represented by this object
belongs to.
- getConfigNameForCategory(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
- getConfigurationInfo() - Method in class org.lsst.ccs.bus.messages.StatusConfigurationInfo
-
Get the ConfigurationInfo object contained in this message.
- getConfigurationName() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
- getConfigurationState() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
- getConfiguredValue() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
The configured value for this parameter, i.e the value defined by the
last configuration loading.
- getCorrelationId() - Method in class org.lsst.ccs.bus.messages.CommandMessage
-
The correlationId of this CommandMessage.
- getCurrentValue() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
The current value for this parameter.
- getCurrentValueForParameter(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Return the current value of a given configurable parameter
- getCurrentValuesFor(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Returns the current value of each parameter that belong to the specified
configurable component.
- getCurrentValuesForCategory(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Returns the current value of each parameter that belong to the specified
category.
- getCurrentValuesForComponent(String) - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
- getDataKey() - Method in class org.lsst.ccs.bus.messages.StatusSubsystemData
-
Get the Key of the embedded object.
- getDescription() - Method in class org.lsst.ccs.bus.data.Alert
-
Get the Alert description
- getDescription() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance
-
Deprecated.
- getDescriptionName() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Returns the subsystem description name, ie the name of the description
file the subsystem is started with.
- getDestination() - Method in class org.lsst.ccs.bus.messages.CommandMessage
-
The destination of the CommandMessage.
- getDistributionInfo(AgentInfo) - Method in class org.lsst.ccs.bus.data.CCSVersions
-
Get the DistributionInfo for a given AgentInfo.
- getDistributionInfo(String) - Method in class org.lsst.ccs.bus.data.CCSVersions
-
Get the DistributionInfo for a given agent by name.
- getEncodedData() - Method in class org.lsst.ccs.bus.messages.BusMessage
-
Get the Encoded version of the embedded Object.
- getEncodedData() - Method in class org.lsst.ccs.bus.messages.CommandReply
-
- getEncodedData() - Method in class org.lsst.ccs.bus.messages.LogMessage
-
- getEncodedData() - Method in class org.lsst.ccs.bus.messages.StatusData
-
- getFormattedDetails() - Method in class org.lsst.ccs.bus.messages.LogMessage
-
The formatted version of the logged message.
- getFreeMemory() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
- getHighestAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory
-
Get the highest AlertState raised for this Alert.
- getInternalStates() - Method in class org.lsst.ccs.bus.states.StateBundle
-
Gets string representations of the internal states.
- getKey() - Method in class org.lsst.ccs.bus.data.KeyValueData
-
Get the key.
- getLastModified() - Method in class org.lsst.ccs.bus.states.StateBundle
-
Get the Instant of the last time the StateBundle
was modified.
- getLatestAlert() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory
-
Get the original Alert that was raised.
- getLatestAlertState() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory
-
Get the latest AlertState of this Alert.
- getLatestAlertTimestamp() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory
-
Get the latest CCS timestamp of this Alert.
- getLatestChanges() - Method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Returns a list of the recent changes caused by the
If a single change is processed, the returned list contains this change only.
- getLevel() - Method in class org.lsst.ccs.bus.messages.LogMessage
-
The level (or severity) of the LogMessage.
- getListOfKeyValueData() - Method in class org.lsst.ccs.bus.data.KeyValueDataList
-
Get the list of KeyValueData contained in this object.
- getListOfKeyValueData(KeyValueData.KeyValueDataType) - Method in class org.lsst.ccs.bus.data.KeyValueDataList
-
Get the list of KeyValueData contained in this object for a given type.
- getLoggerName() - Method in class org.lsst.ccs.bus.messages.LogMessage
-
Get the name of the logger used to record the LogMessage.
- getMaxMemory() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
- getName() - Method in class org.lsst.ccs.bus.data.AgentInfo
-
The Agent's name on the Buses.
- getNewState() - Method in class org.lsst.ccs.bus.messages.StatusStateChangeNotification
-
Get the new state of the Agent.
- getNThreads() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
- getNumberOfInstances() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory
-
Get the number of times this Alert was raised.
- getObject() - Method in class org.lsst.ccs.bus.messages.BusMessage
-
Get the original version of the embedded Object.
- getOldState() - Method in class org.lsst.ccs.bus.messages.StatusStateChangeNotification
-
Get the old state of the Agent.
- getOriginAgentInfo() - Method in class org.lsst.ccs.bus.messages.BusMessage
-
The Origin of the BusMessage, the bus registration name of the Agent from which it
originated.
- getParameterInfoGroupByCategory(List<ConfigurationParameterInfo>) - Static method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Groups the ConfigurationParameterInfo objects of the input list by the category they belong to.
- getParameterInfoGroupByComponent(List<ConfigurationParameterInfo>) - Static method in class org.lsst.ccs.bus.data.ConfigurationInfo
-
Groups the ConfigurationParameterInfo objects of the input list by the component they belong to.
- getParameterName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
Returns the name of the parameter represented by this object.
- getPathName() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
The Path name of the parameter.
- getProcessCpuLoad() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
- getProject() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getRaisedAlert(String) - Method in class org.lsst.ccs.bus.data.RaisedAlertSummary
-
Get a RaisedAlert for a given id.
- getRaisedAlert() - Method in class org.lsst.ccs.bus.messages.StatusRaisedAlert
-
Get the RaisedAlert contained in this message.
- getRaisedAlertInstancesList() - Method in class org.lsst.ccs.bus.data.RaisedAlertHistory
-
Get the full history of RaisedAlertInstances for this Alert.
- getRaisedAlertSummary() - Method in class org.lsst.ccs.bus.messages.StatusAlert
-
- getReason() - Method in class org.lsst.ccs.bus.messages.CommandNack
-
The reason for the refusal.
- getReply() - Method in class org.lsst.ccs.bus.messages.CommandReply
-
Utility method to get the reply contained in this CommandReply.
- getResult() - Method in class org.lsst.ccs.bus.messages.CommandResult
-
Get the result of the CommandRequest execution.
- getRuntimeInfo() - Method in class org.lsst.ccs.bus.messages.StatusRuntimeInfo
-
Get the RuntimeInfo object contained in this message.
- getSourceCodeRevision() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getSourceCodeUrl() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- getSourceName() - Method in class org.lsst.ccs.bus.messages.LogMessage
-
Get the source of the LogMessage.
- getState() - Method in class org.lsst.ccs.bus.messages.StatusMessage
-
Get the published State object that contains the Agent's internal state
at the moment the StatusMessage was published.
- getState(Class<T>) - Method in class org.lsst.ccs.bus.states.StateBundle
-
Returns the current value for the specified State.
- getStatusBroadcastPeriod() - Method in class org.lsst.ccs.bus.messages.StatusHeartBeat
-
- getSubsystemData() - Method in class org.lsst.ccs.bus.messages.StatusSubsystemData
-
Get the embedded subsystem data.
- getSystemCpuLoad() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
- getThreadName() - Method in class org.lsst.ccs.bus.messages.LogMessage
-
Get the name of the thread on which the LogMessage originated.
- getTimeout() - Method in class org.lsst.ccs.bus.messages.CommandAck
-
Returns the timeout value for the command suggested by the command target.
- getTimestamp() - Method in class org.lsst.ccs.bus.data.KeyValueData
-
Get the timestamp associated with the key-value pair.
- getTimestamp() - Method in class org.lsst.ccs.bus.data.RaisedAlertInstance
-
The CCS timestamp of when the RaisedAlertInstance was raised.
- getTimeStamp() - Method in class org.lsst.ccs.bus.messages.BusMessage
-
Get the timestamp in CCS milliseconds of when the message was created.
- getTotalMemory() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
- getType() - Method in class org.lsst.ccs.bus.data.AgentInfo
-
The Agent's AgentType.
- getType() - Method in class org.lsst.ccs.bus.data.ConfigurationParameterInfo
-
Return the type of the parameter.
- getType() - Method in class org.lsst.ccs.bus.data.KeyValueData
-
Get the KeyValueData type.
- getUptime() - Method in class org.lsst.ccs.bus.data.RuntimeInfo
-
Get the Agent's uptime in milliseconds.
- getValue() - Method in class org.lsst.ccs.bus.data.KeyValueData
-
Get the value embedding in this object.
- getVersion() - Method in class org.lsst.ccs.bus.data.DistributionInfo
-
- setOriginAgentInfo(AgentInfo) - Method in class org.lsst.ccs.bus.messages.BusMessage
-
Sets the origin for this BusMessage.
- setState(Enum) - Method in class org.lsst.ccs.bus.states.StateBundle
-
Sets the specified state to the bundle, replacing any previous state of the same type.
- setState(Enum...) - Method in class org.lsst.ccs.bus.states.StateBundle
-
Sets specified states to the bundle, replacing any previous states of the same types.
- SkipEncoding - Annotation Type in org.lsst.ccs.bus.annotations
-
Annotation for classes or fields that are not to be encoded.
- StateBundle - Class in org.lsst.ccs.bus.states
-
Contains a set of subsystem states, each represented by Enum.
- StateBundle(Enum...) - Constructor for class org.lsst.ccs.bus.states.StateBundle
-
Constructs a StateBundle from a set of states.
- StatusAlert<T extends Serializable,D> - Class in org.lsst.ccs.bus.messages
-
Base class for Alert raising and clearing status.
- StatusClearedAlert - Class in org.lsst.ccs.bus.messages
-
Status message sent when Alerts are cleared.
- StatusClearedAlert(String[], StateBundle, RaisedAlertSummary) - Constructor for class org.lsst.ccs.bus.messages.StatusClearedAlert
-
Build a StatusClearAlert from the provided String array and the
RaisedAlertSummary of the subsystem.
- StatusConfigurationInfo - Class in org.lsst.ccs.bus.messages
-
A status message containing a ConfigurationInfo object.
- StatusConfigurationInfo(ConfigurationInfo, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusConfigurationInfo
-
Create a StatusConfigurationInfo message by providing the state of the agent
and the ConfigurationInfo object to be sent.
- StatusData - Class in org.lsst.ccs.bus.messages
-
Base class for all status messages containing data that is meant to be
stored in the trending database.
- StatusData(KeyValueData, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusData
-
Build a StatusMessage from the provided Object.
- StatusEnum<T extends Enum<T>> - Class in org.lsst.ccs.bus.messages
-
Status message containing an Enum, encoded as a String..
- StatusEnum(T, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusEnum
-
- StatusHeartBeat - Class in org.lsst.ccs.bus.messages
-
Heartbeat status message.
- StatusHeartBeat(int, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusHeartBeat
-
- StatusMessage<T extends Serializable,D> - Class in org.lsst.ccs.bus.messages
-
Base class for all messages sent on the Status Bus.
- StatusMessage(T, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusMessage
-
Build a StatusMessage from the provided Object.
- StatusRaisedAlert - Class in org.lsst.ccs.bus.messages
-
Base class for all status messages containing an RaisedAlert.
- StatusRaisedAlert(Alert, String, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusRaisedAlert
-
- StatusRaisedAlert(Alert, String, StateBundle, RaisedAlertSummary) - Constructor for class org.lsst.ccs.bus.messages.StatusRaisedAlert
-
Build a StatusAlert from the provided RaisedAlert.
- StatusRuntimeInfo - Class in org.lsst.ccs.bus.messages
-
A status message containing a RuntimeInfo object.
- StatusRuntimeInfo(RuntimeInfo, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusRuntimeInfo
-
Create a StatusRuntimeInfo message by providing the state of the agent.
- StatusStateChangeNotification - Class in org.lsst.ccs.bus.messages
-
A StatusChangeNotification for State changes.
- StatusStateChangeNotification(StateBundle, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusStateChangeNotification
-
Create a StatusStateChangeNotification object.
- StatusSubsystemData - Class in org.lsst.ccs.bus.messages
-
Base class for all status messages containing data that is private
to the sender Subsystem.
- StatusSubsystemData(KeyValueData, StateBundle) - Constructor for class org.lsst.ccs.bus.messages.StatusSubsystemData
-
Build a StatusMessage from the provided Object.
- systemCpuLoad - Variable in class org.lsst.ccs.bus.data.RuntimeInfo
-
- valueOf(String) - Static method in enum org.lsst.ccs.bus.data.AgentInfo.AgentType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.data.KeyValueData.KeyValueDataType
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.definition.Bus
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.states.AlertState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.states.CommandState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.states.ConfigurationState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.states.OperationalState
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.lsst.ccs.bus.states.PhaseState
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.lsst.ccs.bus.data.AgentInfo.AgentType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.data.KeyValueData.KeyValueDataType
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.definition.Bus
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.states.AlertState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.states.CommandState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.states.ConfigurationState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.states.OperationalState
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum org.lsst.ccs.bus.states.PhaseState
-
Returns an array containing the constants of this enum type, in
the order they are declared.