Package com.polarion.platform.jobs.scheduler

Class JobExecutionRequest

java.lang.Object

com.polarion.platform.jobs.scheduler.JobExecutionRequest

All Implemented Interfaces:

Serializable

public final class JobExecutionRequest
extends Object
implements Serializable

Job execution request.

Author:

Stepan Roh, Polarion Software

See Also:

• IJobSchedulerService
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_SCOPE	Job scope parameter name - see IJobUnit.setScope(com.polarion.platform.context.IContext)

Constructor Summary

Constructors

Constructor	Description
JobExecutionRequest(String jobName, String jobLabel, Map parameters)	Creates the request without cluster node preference.
JobExecutionRequest(String jobName, String jobLabel, Map parameters, NodeSelector nodeSelector)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getJobLabel()	Returns job label.
String	getJobName()	Returns job name.
NodeSelector	getNodeSelector()	Determines on which node the job should run in a cluster setup.
Map	getParameters()	Returns job parameters.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

PARAM_SCOPE

public static final String PARAM_SCOPE

Job scope parameter name - see IJobUnit.setScope(com.polarion.platform.context.IContext)

See Also:

• Constant Field Values

Constructor Details

JobExecutionRequest

public JobExecutionRequest(String jobName,
 String jobLabel,
 Map parameters)

Creates the request without cluster node preference.

See Also:

• JobExecutionRequest

JobExecutionRequest

public JobExecutionRequest(String jobName,
 String jobLabel,
 Map parameters,
 NodeSelector nodeSelector)

Constructor.

Given job parameters can be of any type - system will try to convert them to proper values upon creation of IJobUnit. Mapping from parameter name to set method follows Java Beans convention: first character is capitalized and set is prepended.

Parameters:

jobName - job name (see IJobUnitFactory.getName())

jobLabel - job label (see IJobUnitFactory.createJobUnit(String))

parameters - job parameters as Map between String key and Object value

nodeSelector - cluster node selector (see getNodeSelector())

Throws:

IllegalArgumentException - if jobName is null

IllegalArgumentException - if jobLabel is null

IllegalArgumentException - if parameters is null

IllegalArgumentException - if nodeSelector is null

Since:

3.8.0

Method Details

getJobLabel

public String getJobLabel()

Returns job label.

Returns:

job label (not null)

getJobName

public String getJobName()

Returns job name.

Returns:

job name (not null)

getParameters

public Map getParameters()

Returns job parameters.

Returns:

job parameters (not null)

getNodeSelector

@NotNull
public NodeSelector getNodeSelector()

Determines on which node the job should run in a cluster setup. Note that in order to run a job on a remote node it is required that all the job parameters are serializable.

Since:

3.8.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object