net.scattersphere.data.message

Class JobParametersMessage

java.lang.Object

net.scattersphere.data.message.JobParametersMessage

All Implemented Interfaces:

Serializable

public class JobParametersMessage
extends Object
implements Serializable

This class is used to indicate that a job needs to be started, or stopped on a server. Created by kenji on 12/5/14.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobParametersMessage(String jobName, String[] jobParameters) Constructor that sets the job name and its parameters.
JobParametersMessage(String jobName, String jobMessage, String[] jobParameters) Constructor.

Method Summary

Modifier and Type	Method and Description
static JobParametersMessage	fromByteArray(byte[] array) Deserializes the payload sent, returning a new JobParametersMessage on success.
String	getJobMessage() Retrieves the job reason message, if set.
String	getJobName() Returns the name of the job.
String[]	getJobParameters() Retrieves the list of parameters set.
byte[]	toByteArray() Returns a serialized version of this class.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

JobParametersMessage

public JobParametersMessage(String jobName,
                            String jobMessage,
                            String[] jobParameters)

Constructor.

Parameters:

jobName - The name of the job.

jobMessage - The job reason message for stopping, if applicable.

jobParameters - The String array of parameters to send to the job.

JobParametersMessage

public JobParametersMessage(String jobName,
                            String[] jobParameters)

Constructor that sets the job name and its parameters.

Parameters:

jobName - The name of the job.

jobParameters - The String array of parameters to send to the job.

Method Detail

getJobName

public String getJobName()

Returns the name of the job.

Returns:

String containing the job name.

getJobMessage

public String getJobMessage()

Retrieves the job reason message, if set.

Returns:

String containing the job message.

getJobParameters

public String[] getJobParameters()

Retrieves the list of parameters set.

Returns:

String[] array containing the parameters list, 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 JobParametersMessage fromByteArray(byte[] array)

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

Parameters:

array - byte[] array of data to deserialize.

Returns:

JobParametersMessage on success, null otherwise.

toString

public String toString()

Overrides:

toString in class Object