org.lsst.ccs.bus.messages

Class BusMessage<T extends Serializable,D>

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<T,D>

Type Parameters:

T - Template class for the embedded object. It must be Serializable.

D - Template class for the encoded object

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandMessage, LogMessage, StatusMessage

public abstract class BusMessage<T extends Serializable,D>
extends Object
implements Serializable

Base class for messages sent on the buses. Concrete implementations (command, status and log messages) will be sent on the appropriate bus. Each BusMessage wraps a Serializable Object to be sent over the buses. Of this Object it contains its byte code representation and its Encoded version. The return value of the encoding process depends on the different subclasses. Refer to their documentation for more information. Clients receiving this message can choose to use the encoded version of the embedded Object (which is always available), or, if they have the class definition of the embedded Object, use the de-serialized version of the Object. The embedded object is serialized and encoded when the BusMessage is serialized, i.e. right before being shipped over the buses. Additional information contained by the BusMessage:

• class name: the class of the embedded object
• AgentInfo : the information of the Agent from which the message originated
• creation timestamp : the timestamp in CCS milliseconds of when the BusMessage was created

This information can be used to filter on the bus messages.

Author:

LSST CCS Team

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T	obj

Constructor Summary

Constructors

Constructor and Description
BusMessage(Class clazz, byte[] ser, String compressionProtocol) Build a BusMessage from a the serialized byte array of an object.
BusMessage(T obj) Build a BusMessage from the provided Object.
BusMessage(T obj, boolean skipSerialization) Build a BusMessage from the provided Object.

Method Summary

Modifier and Type	Method and Description
protected abstract D	encodeObject(T obj) Subclasses must provide a specific implementation of the encoding process.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getCCSTimeStamp() Get the CCSTimeStamp of when this message was created.
String	getClassName() Get the class name of the embedded object.
Duration	getDeserializationDuration()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getDoneDeSerializationTime()
D	getEncodedData() Get the Encoded version of the embedded Object.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getIncomingQueueInTimeStamp()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getIncomingQueueOutTimeStamp()
T	getObject() Get the original version of the embedded Object.
AgentInfo	getOriginAgentInfo() The Origin of the BusMessage, the bus registration name of the Agent from which it originated.
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getOutgoingQueueInTimeStamp()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getOutgoingQueueOutTimeStamp()
Duration	getSerializationDuration()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getSerializationTime()
Duration	getTransferDuration() Get the Transfer Duration, this is the time it took from when the BusMessage was serialized to when it was de-serialized.
void	setIncomingQueueInTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp incomingQueueInTimeStamp)
void	setIncomingQueueOutTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp incomingQueueOutTimeStamp)
void	setOriginAgentInfo(AgentInfo agent) Sets the origin for this BusMessage.
void	setOutgoingQueueInTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp outgoingQueueInTimeStamp)
void	setOutgoingQueueOutTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp outgoingQueueOutTimeStamp)
String	toString()
void	updateTimingInformation(BusMessage msg)

Methods inherited from class java.lang.Object

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

Field Detail

obj

protected final transient T extends Serializable obj

Constructor Detail

BusMessage

public BusMessage(Class clazz,
                  byte[] ser,
                  String compressionProtocol)

Build a BusMessage from a the serialized byte array of an object.

Parameters:

clazz - The Class of the serialized object.

ser - The serialized version of the object to be sent over the buses.

compressionProtocol - specify the compression protocol used on the provided byte[]. "none" means that the byte[] was not compressed. "gzip" means that it has been gzipped.

BusMessage

public BusMessage(T obj)

Build a BusMessage from the provided Object. The provided object can be null, in which case no serialization or encoding occurs.

Parameters:

obj - The Serializable object to be sent over the buses.

BusMessage

public BusMessage(T obj,
                  boolean skipSerialization)

Build a BusMessage from the provided Object. The provided object can be null, in which case no serialization or encoding occurs.

Parameters:

obj - The Serializable object to be sent over the buses.

skipSerialization - do not serialize the object. This is to be true only for messages that are created on the client side during the preProcessBusMessage step.

Method Detail

encodeObject

protected abstract D encodeObject(T obj)

Subclasses must provide a specific implementation of the encoding process.

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.

getClassName

public String getClassName()

Get the class name of the embedded object.

Returns:

The class name of the embedded Object.

getEncodedData

public D getEncodedData()

Get the Encoded version of the embedded Object.

Returns:

The Encoded version of the embedded Object.

getObject

public T getObject()

Get the original version of the embedded Object.

Returns:

The de serialized version of the embedded Object

Throws:

EmbeddedObjectDeserializationException - if the embedded object cannot be de-serialized.

getOriginAgentInfo

public AgentInfo getOriginAgentInfo()

The Origin of the BusMessage, the bus registration name of the Agent from which it originated.

Returns:

The origin of this BusMessage.

setOriginAgentInfo

public final void setOriginAgentInfo(AgentInfo agent)

Sets the origin for this BusMessage. This method should only be used internally, by the MessagingLayer Architecture. It must not be used by users/developers.

Parameters:

agent - The origin of the BusMessage.

getCCSTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getCCSTimeStamp()

Get the CCSTimeStamp of when this message was created.

Returns:

The CCSTimeStamp when this object was created.

toString

public String toString()

Overrides:

toString in class Object

getTransferDuration

public Duration getTransferDuration()

Get the Transfer Duration, this is the time it took from when the BusMessage was serialized to when it was de-serialized.

Returns:

getDoneDeSerializationTime

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getDoneDeSerializationTime()

getSerializationTime

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getSerializationTime()

getSerializationDuration

public Duration getSerializationDuration()

getDeserializationDuration

public Duration getDeserializationDuration()

updateTimingInformation

public void updateTimingInformation(BusMessage msg)

getOutgoingQueueOutTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getOutgoingQueueOutTimeStamp()

setOutgoingQueueOutTimeStamp

public void setOutgoingQueueOutTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp outgoingQueueOutTimeStamp)

getOutgoingQueueInTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getOutgoingQueueInTimeStamp()

setOutgoingQueueInTimeStamp

public void setOutgoingQueueInTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp outgoingQueueInTimeStamp)

getIncomingQueueOutTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getIncomingQueueOutTimeStamp()

setIncomingQueueOutTimeStamp

public void setIncomingQueueOutTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp incomingQueueOutTimeStamp)

getIncomingQueueInTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getIncomingQueueInTimeStamp()

setIncomingQueueInTimeStamp

public void setIncomingQueueInTimeStamp(org.lsst.ccs.utilities.taitime.CCSTimeStamp incomingQueueInTimeStamp)