uws.job.parameters

Class ExecutionDurationController

java.lang.Object

uws.job.parameters.ExecutionDurationController

All Implemented Interfaces:

java.io.Serializable, InputParamController

public class ExecutionDurationController
extends java.lang.Object
implements InputParamController, java.io.Serializable

Let controlling the execution duration of all jobs managed by a UWS. Thus it is possible to set a default and a maximum value. Moreover you can indicate whether the execution duration of jobs can be modified by the user or not.

Note: the execution duration is always expressed in seconds.

Note: By default, the execution duration can be modified by anyone without any limitation. The default and maximum value is UWSJob.UNLIMITED_DURATION.

The logic of the execution duration is set in this class. Here it is:

• If no value is specified by the UWS client, the default value is returned.
• If no default value is provided, the maximum duration is returned.
• If no maximum value is provided, there is no limit (=UWSJob.UNLIMITED_DURATION).

Version:

4.1 (11/2014)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowModification Indicates whether the execution duration of jobs can be modified.
protected long	defaultDuration The default duration (in seconds).
protected long	maxDuration The maximum duration (in seconds).

Constructor Summary

Constructors

Constructor and Description
ExecutionDurationController() Create a controller for the execution duration.
ExecutionDurationController(long defaultDuration, long maxDuration, boolean allowModification) Create a controller for the execution duration.

Method Summary

Modifier and Type	Method and Description
boolean	allowModification() Tells whether the execution duration of any managed job can be modified.
void	allowModification(boolean allowModification) Lets indicating whether the execution duration of any managed job can be modified.
java.lang.Object	check(java.lang.Object value) Checks the value of the controlled parameter and builds a new object from this value.
java.lang.Object	getDefault() Returns the default value of the controlled parameter.
long	getDefaultExecutionDuration() Deprecated. This function is completely equivalent to getDefault().
long	getMaxExecutionDuration() Gets the maximum execution duration.
boolean	setDefaultExecutionDuration(long defaultExecutionDuration) Sets the default execution duration.
void	setMaxExecutionDuration(long maxExecutionDuration) Sets the maximum execution duration.

Methods inherited from class java.lang.Object

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

Field Detail

defaultDuration

protected long defaultDuration

The default duration (in seconds).

maxDuration

protected long maxDuration

The maximum duration (in seconds).

allowModification

protected boolean allowModification

Indicates whether the execution duration of jobs can be modified.

Constructor Detail

ExecutionDurationController

public ExecutionDurationController()

Create a controller for the execution duration. By default, there is no maximum value and the default duration is UWSJob.UNLIMITED_DURATION.

A default and/or maximum value can be set after creation using setDefaultExecutionDuration(long) and setMaxExecutionDuration(long). By default this parameter can always be modified, but it can be forbidden using allowModification(boolean).

ExecutionDurationController

public ExecutionDurationController(long defaultDuration,
                                   long maxDuration,
                                   boolean allowModification)

Create a controller for the execution duration. The default and the maximum duration are initialized with the given parameters. The third parameter allows also to forbid the modification of the execution duration by the user, if set to false.

A default and/or maximum value can be modified after creation using setDefaultExecutionDuration(long) and setMaxExecutionDuration(long). The flag telling whether this parameter can be modified by the user can be changed using allowModification(boolean).

Parameters:

defaultDuration - Duration (in seconds) set by default to a job, when none is specified.

maxDuration - Maximum duration (in seconds) that can be set. If a greater value is provided by the user, an exception will be thrown by check(Object).

allowModification - true to allow the user to modify this value when creating a job, false otherwise.

Method Detail

getDefault

public java.lang.Object getDefault()

Description copied from interface: InputParamController

Returns the default value of the controlled parameter.

Specified by:

getDefault in interface InputParamController

Returns:

Default value (null is allowed).

check

public java.lang.Object check(java.lang.Object value)
                       throws UWSException

Description copied from interface: InputParamController

Checks the value of the controlled parameter and builds a new object from this value.

Specified by:

check in interface InputParamController

Parameters:

value - Parameter value to check.

Returns:

The same value or a new object built from the given value.

Throws:

UWSException - If the given value is strongly incorrect.

getDefaultExecutionDuration

@Deprecated
public final long getDefaultExecutionDuration()

Deprecated. This function is completely equivalent to getDefault().

Gets the default execution duration.

Returns:

The default execution duration (in seconds) (0 or less mean an unlimited duration).

setDefaultExecutionDuration

public final boolean setDefaultExecutionDuration(long defaultExecutionDuration)

Sets the default execution duration.

Parameters:

defaultExecutionDuration - The new default execution duration (in seconds) (UWSJob.UNLIMITED_DURATION, 0 or a negative value mean an unlimited duration).

getMaxExecutionDuration

public final long getMaxExecutionDuration()

Gets the maximum execution duration.

Returns:

The maximum execution duration (in seconds) (0 or less mean an unlimited duration).

setMaxExecutionDuration

public final void setMaxExecutionDuration(long maxExecutionDuration)

Sets the maximum execution duration.

Parameters:

maxExecutionDuration - The maximum execution duration (in seconds) (UWSJob.UNLIMITED_DURATION, 0 or a negative value mean an unlimited duration).

allowModification

public final boolean allowModification()

Tells whether the execution duration of any managed job can be modified.

Specified by:

allowModification in interface InputParamController

Returns:

true if the execution duration can be modified, false otherwise.

allowModification

public final void allowModification(boolean allowModification)

Lets indicating whether the execution duration of any managed job can be modified.

Parameters:

allowModification - true if the execution duration can be modified, false otherwise.