tap.parameters

Class TAPDestructionTimeController

java.lang.Object

tap.parameters.TAPDestructionTimeController

All Implemented Interfaces:

InputParamController

public class TAPDestructionTimeController
extends java.lang.Object
implements InputParamController

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

Note: By default, the destruction time can be modified by anyone without any limitation. There is no default value (that means jobs may stay forever).

The logic of the destruction time 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 destruction date is returned.
• If no maximum value is provided, there is no destruction.

Version:

2.0 (11/2014)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowModification Indicates 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
TAPDestructionTimeController(ServiceConnection service) Build a controller for the Destruction 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 destruction time 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.
int	getDefaultRetentionPeriod() Get the default period during which a job is kept.
java.util.Date	getMaxDestructionTime() Gets the maximum destruction time: either computed with an interval of time or obtained directly by a maximum destruction time.
int	getMaxRetentionPeriod() Get the maximum period during which a job is kept.

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

Indicates whether the execution duration of jobs can be modified.

Constructor Detail

TAPDestructionTimeController

public TAPDestructionTimeController(ServiceConnection service)

Build a controller for the Destruction 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 destruction time of any managed job can be modified.

Parameters:

allowModif - true if the destruction time can be modified, false otherwise.

getDefaultRetentionPeriod

public final int getDefaultRetentionPeriod()

Get the default period during which a job is kept. After this period, the job should be destroyed.

Returns:

The default retention period, -1 if none is provided.

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

getMaxRetentionPeriod

public final int getMaxRetentionPeriod()

Get the maximum period during which a job is kept. After this period, the job should be destroyed.

Returns:

The maximum retention period, -1 if none is provided.

getMaxDestructionTime

public final java.util.Date getMaxDestructionTime()

Gets the maximum destruction time: either computed with an interval of time or obtained directly by a maximum destruction time.

Returns:

The maximum destruction time (null means that jobs may stay forever).

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.