net.scattersphere.data.message

Class JobMessage

java.lang.Object

net.scattersphere.data.message.JobMessage

All Implemented Interfaces:

Serializable

public class JobMessage
extends Object
implements Serializable

This is a transport message class that is used by Scattersphere to send messages between servers and clients. It contains a message, an action, and a payload. Created by kenji on 11/30/14.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobMessage(String message) Constructor that only stores a message.
JobMessage(String message, byte[] payload) Constructor that takes a message and payload with no action.
JobMessage(String message, String action) Constructor that takes a message and action with no payload.
JobMessage(String message, String action, byte[] payload) Constructor.

Method Summary

Modifier and Type	Method and Description
static JobMessage	fromByteArray(byte[] array) Deserializes a JobMessage object from a payload.
String	getAction() Retrieves the action.
String	getMessage() Retrieves the message.
byte[]	getPayload() Retrieves the payload.
byte[]	toByteArray() Serializes this object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobMessage

public JobMessage(String message,
                  String action,
                  byte[] payload)

Constructor.

Parameters:

message - The message to store.

action - The action associated with the message.

payload - The serialized payload to send.

JobMessage

public JobMessage(String message)

Constructor that only stores a message.

Parameters:

message - The message to store.

JobMessage

public JobMessage(String message,
                  String action)

Constructor that takes a message and action with no payload.

Parameters:

message - The message to store.

action - The action associated with the message.

JobMessage

public JobMessage(String message,
                  byte[] payload)

Constructor that takes a message and payload with no action.

Parameters:

message - The message to store.

payload - The payload to attach.

Method Detail

getMessage

public String getMessage()

Retrieves the message.

Returns:

String containing the message.

getAction

public String getAction()

Retrieves the action.

Returns:

String containing the action.

getPayload

public byte[] getPayload()

Retrieves the payload.

Returns:

byte[] containing the payload of data.

toByteArray

public byte[] toByteArray()

Serializes this object.

Returns:

byte[] containing the serialized data.

fromByteArray

public static JobMessage fromByteArray(byte[] array)

Deserializes a JobMessage object from a payload.

Parameters:

array - byte[] of data to deserialize.

Returns:

JobMessage after deserialization, null if it could not be deserialized.

toString

public String toString()

Overrides:

toString in class Object