org.lsst.ccs.bus

Class BusMessage

java.lang.Object

org.lsst.ccs.bus.BusMessage

All Implemented Interfaces:

Serializable, BusPayload

Direct Known Subclasses:

Command, CommandAckOrReply, LogEvent, Status

public abstract class BusMessage
extends Object
implements Serializable, BusPayload

Generic abstract bus message class Concrete implementations (command, status, logevent) will be sent on the appropriate bus.

Author:

aubourg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DetailLevel	detailLevel
protected String	origin
protected PriorityLevel	priorityLevel
protected String	summary
protected long	timeStamp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BusMessage()
protected	BusMessage(String origin)

Method Summary

Methods

Modifier and Type	Method and Description
DetailLevel	getDetailLevel()
abstract String	getMessageType()
String	getOrigin() the origin subsystem
PriorityLevel	getPriorityLevel()
String	getSummary() a summary string
long	getTimeStamp() timestamp, in milliseconds since 1970
void	setDetailLevel(DetailLevel detailLevel) Sets the detail level.
void	setOrigin(String origin)
void	setPriorityLevel(PriorityLevel priorityLevel) Sets the priority level.
void	setSummary(String summary)
void	setTimeStamp(long timeStamp)

Methods inherited from class java.lang.Object

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

Field Detail

origin

protected String origin

summary

protected String summary

detailLevel

protected DetailLevel detailLevel

priorityLevel

protected PriorityLevel priorityLevel

timeStamp

protected long timeStamp

Constructor Detail

BusMessage

protected BusMessage(String origin)

BusMessage

protected BusMessage()

Method Detail

getMessageType

public abstract String getMessageType()

getOrigin

public String getOrigin()

the origin subsystem

setOrigin

public void setOrigin(String origin)

getTimeStamp

public long getTimeStamp()

timestamp, in milliseconds since 1970

setTimeStamp

public void setTimeStamp(long timeStamp)

getSummary

public String getSummary()

a summary string

Returns:

setSummary

public void setSummary(String summary)

getDetailLevel

public DetailLevel getDetailLevel()

setDetailLevel

public void setDetailLevel(DetailLevel detailLevel)

Sets the detail level. Will impact for instance the retention duration of the message

getPriorityLevel

public PriorityLevel getPriorityLevel()

setPriorityLevel

public void setPriorityLevel(PriorityLevel priorityLevel)

Sets the priority level. Will be translated into a transport layer priority