tap.parameters

Class TAPExecutionDurationController

java.lang.Object

tap.parameters.TAPExecutionDurationController

All Implemented Interfaces:

InputParamController

public class TAPExecutionDurationController
extends java.lang.Object
implements InputParamController

Let controlling the execution duration of all jobs managed by a TAP service. The maximum and default values are provided by the service connection.

Note: By default, the execution duration can be modified by anyone without any limitation. The default 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 TAP 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:

2.1 (09/2016)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowModification Indicate whether the execution duration of jobs can be modified.
protected ServiceConnection	service Connection to the service which knows the maximum and default value of this parameter.

Constructor Summary

Constructors

Constructor and Description
TAPExecutionDurationController(ServiceConnection service) Build a controller for the ExecutionDuration parameter.

Method Summary

Modifier and Type	Method and Description
boolean	allowModification() Tells whether the controlled parameter may be modified after initialization.
void	allowModification(boolean allowModif) Let indicate 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	getMaxDuration() Gets the maximum execution duration.

Methods inherited from class java.lang.Object

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

Field Detail

service

protected final ServiceConnection service

Connection to the service which knows the maximum and default value of this parameter.

allowModification

protected boolean allowModification

Indicate whether the execution duration of jobs can be modified.

Constructor Detail

TAPExecutionDurationController

public TAPExecutionDurationController(ServiceConnection service)

Build a controller for the ExecutionDuration parameter.

Parameters:

service - Connection to the TAP service.

Method Detail

allowModification

public final boolean allowModification()

Description copied from interface: InputParamController

Tells whether the controlled parameter may be modified after initialization.

Specified by:

allowModification in interface InputParamController

Returns:

true to allow the modification, false otherwise.

allowModification

public final void allowModification(boolean allowModif)

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

Parameters:

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

getDefault

public final 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).

getMaxDuration

public final long getMaxDuration()

Gets the maximum execution duration.

Returns:

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

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.