net.scattersphere.data.message

Class JobResponseMessage

java.lang.Object

net.scattersphere.data.message.JobResponseMessage

All Implemented Interfaces:

Serializable

public class JobResponseMessage
extends Object
implements Serializable

This is a packet message that is sent when a job status is requested. Created by kenji on 1/25/15.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobResponseMessage(String jobId, String jobStatus) Constructor that takes the job ID and status.
JobResponseMessage(String jobId, String jobStatus, String jobMessage, Exception jobException) Constructor.

Method Summary

Modifier and Type	Method and Description
static JobResponseMessage	fromByteArray(byte[] array) Deserializes the payload sent, returning a new JobResponseMessage on success.
Exception	getJobException() Returns an Exception, if one occurred for this job.
String	getJobId() Retrieves the job ID.
String	getJobMessage() Retrieves the job cancellation/interruption message if one exists.
String	getJobStatus() Retrieves the job status.
byte[]	toByteArray() Returns a serialized version of this class.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobResponseMessage

public JobResponseMessage(String jobId,
                          String jobStatus,
                          String jobMessage,
                          Exception jobException)

Constructor.

Parameters:

jobId - The Job ID.

jobStatus - The status of the job.

jobMessage - The job interruption message, if one occurred.

jobException - The Exception for the job if one occurred.

JobResponseMessage

public JobResponseMessage(String jobId,
                          String jobStatus)

Constructor that takes the job ID and status.

Parameters:

jobId - The Job ID.

jobStatus - The status of the job.

Method Detail

getJobId

public String getJobId()

Retrieves the job ID.

Returns:

String containing the job ID.

getJobStatus

public String getJobStatus()

Retrieves the job status.

Returns:

String containing the status of the job.

getJobMessage

public String getJobMessage()

Retrieves the job cancellation/interruption message if one exists.

Returns:

String containing the job interruption message.

getJobException

public Exception getJobException()

Returns an Exception, if one occurred for this job.

Returns:

Exception for the job, null if not set.

toByteArray

public byte[] toByteArray()

Returns a serialized version of this class.

Returns:

byte[] array containing the serialized payload.

fromByteArray

public static JobResponseMessage fromByteArray(byte[] array)

Deserializes the payload sent, returning a new JobResponseMessage on success.

Parameters:

array - byte[] array of data to deserialize.

Returns:

JobResponseMessage on success, null otherwise.