org.ow2.proactive.scheduler.common.task

Class CommonAttribute

java.lang.Object

org.ow2.proactive.scheduler.common.task.CommonAttribute

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Job, Task

@PublicAPI
public abstract class CommonAttribute
extends Object
implements Serializable

Definition of the common attributes between job and task.

Since:

ProActive Scheduling 0.9.1

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERIC_INFO_START_AT_KEY The key for specifying start at time as generic information
protected Map<String,String>	genericInformation Common user informations
protected UpdatableProperties<IntegerWrapper>	maxNumberOfExecution The maximum number of execution for a task (default 1).
protected UpdatableProperties<OnTaskError>	onTaskError OnTaskError defines the behavior happening when a task fails.
protected UpdatableProperties<RestartMode>	restartTaskOnError Define where will a task be restarted if an error occurred (default is ANYWHERE).
protected Map<String,String>	unresolvedGenericInformation

Constructor Summary

Constructors

Constructor and Description
CommonAttribute()

Method Summary

Modifier and Type	Method and Description
void	addGenericInformation(String key, String genericInformation) Add an information to the generic informations map field.
void	addGenericInformations(Map<String,String> genericInformations) Add a map of generic informations into the generic informations map field.
protected static Map<String,String>	applyReplacementsOnGenericInformation(Map<String,String> genericInformation, Map<String,Serializable> variables)
Map<String,String>	getGenericInformation() Returns generic information.
int	getMaxNumberOfExecution() Get the number of execution allowed for this task.
UpdatableProperties<IntegerWrapper>	getMaxNumberOfExecutionProperty() Get the maximum number Of Execution updatable property.
UpdatableProperties<OnTaskError>	getOnTaskErrorProperty() Get the OnTaskError UpdatableProperties.
RestartMode	getRestartTaskOnError() Returns the restartTaskOnError state.
UpdatableProperties<RestartMode>	getRestartTaskOnErrorProperty() Get the restartTaskOnError updatable property.
Map<String,String>	getUnresolvedGenericInformation() Returns the generic information without variable replacements.
void	setGenericInformation(Map<String,String> genericInformation) Set the generic information as a hash map.
void	setMaxNumberOfExecution(int numberOfExecution) To set the number of execution for this task.
void	setOnTaskError(OnTaskError onTaskError) Set onTaskError property value.
void	setRestartTaskOnError(RestartMode restartOnError) Sets the restartTaskOnError to the given restartOnError value.
void	setUnresolvedGenericInformation(Map<String,String> unresolvedGenericInformation) Set the generic information without variable replacement.

Methods inherited from class java.lang.Object

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

Field Detail

GENERIC_INFO_START_AT_KEY

public static final String GENERIC_INFO_START_AT_KEY

The key for specifying start at time as generic information

See Also:

Constant Field Values

restartTaskOnError

protected UpdatableProperties<RestartMode> restartTaskOnError

Define where will a task be restarted if an error occurred (default is ANYWHERE).

It will be restarted according to the number of execution remaining.

You can override this property inside each task.

maxNumberOfExecution

protected UpdatableProperties<IntegerWrapper> maxNumberOfExecution

The maximum number of execution for a task (default 1).

You can override this property inside each task.

genericInformation

protected Map<String,String> genericInformation

Common user informations

unresolvedGenericInformation

protected Map<String,String> unresolvedGenericInformation

onTaskError

protected UpdatableProperties<OnTaskError> onTaskError

OnTaskError defines the behavior happening when a task fails.

Constructor Detail

CommonAttribute

public CommonAttribute()

Method Detail

setOnTaskError

public void setOnTaskError(OnTaskError onTaskError)

Set onTaskError property value.

Parameters:

onTaskError - A OnTaskError instance.

Throws:

IllegalArgumentException - If set to null.

getOnTaskErrorProperty

public UpdatableProperties<OnTaskError> getOnTaskErrorProperty()

Get the OnTaskError UpdatableProperties.

Returns:

Reference to the UpdatableProperties instance hold by this class.

getRestartTaskOnError

public RestartMode getRestartTaskOnError()

Returns the restartTaskOnError state.

Returns:

the restartTaskOnError state.

setRestartTaskOnError

public void setRestartTaskOnError(RestartMode restartOnError)

Sets the restartTaskOnError to the given restartOnError value. (Default is 'ANYWHERE')

Parameters:

restartOnError - the restartOnError to set.

getRestartTaskOnErrorProperty

public UpdatableProperties<RestartMode> getRestartTaskOnErrorProperty()

Get the restartTaskOnError updatable property.

Returns:

the restartTaskOnError updatable property.

getMaxNumberOfExecution

public int getMaxNumberOfExecution()

Get the number of execution allowed for this task.

Returns:

the number of execution allowed for this task

setMaxNumberOfExecution

public void setMaxNumberOfExecution(int numberOfExecution)

To set the number of execution for this task. (Default is 1)

Parameters:

numberOfExecution - the number of times this task can be executed

getMaxNumberOfExecutionProperty

public UpdatableProperties<IntegerWrapper> getMaxNumberOfExecutionProperty()

Get the maximum number Of Execution updatable property.

Returns:

the maximum number Of Execution updatable property

getGenericInformation

public Map<String,String> getGenericInformation()

Returns generic information.

These information are transmitted to the policy that can use it for the scheduling.

Returns:

generic information.

getUnresolvedGenericInformation

public Map<String,String> getUnresolvedGenericInformation()

Returns the generic information without variable replacements.

Returns:

unresolved generic information.

addGenericInformation

public void addGenericInformation(String key,
                                  String genericInformation)

Add an information to the generic informations map field. This information will be given to the scheduling policy.

Parameters:

key - the key in which to store the informations.

genericInformation - the information to store.

addGenericInformations

public void addGenericInformations(Map<String,String> genericInformations)

Add a map of generic informations into the generic informations map field.

Parameters:

genericInformations - the generic informations map to add.

setGenericInformation

public void setGenericInformation(Map<String,String> genericInformation)

Set the generic information as a hash map.

Parameters:

genericInformation - the generic information to set.

setUnresolvedGenericInformation

public void setUnresolvedGenericInformation(Map<String,String> unresolvedGenericInformation)

Set the generic information without variable replacement.

Parameters:

unresolvedGenericInformation - the raw generic information to set.

applyReplacementsOnGenericInformation

protected static Map<String,String> applyReplacementsOnGenericInformation(Map<String,String> genericInformation,
                                                                          Map<String,Serializable> variables)