uws.job

Enum JobDestructionPolicy

java.lang.Object

java.lang.Enum<JobDestructionPolicy>

uws.job.JobDestructionPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JobDestructionPolicy>

public enum JobDestructionPolicy
extends java.lang.Enum<JobDestructionPolicy>

Behavior to apply when a job destruction is asked.

This policy must be set individually on JobList instances. Thus, the jobs lists of a UWS service may have a different behavior when a job destruction is required.

Since:

4.3, JobList.destroyJob(String), JobList.destroyJob(String, JobOwner)

Version:

4.3 (09/2017)

Author:

Grégory Mantelet (ARI)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS_ARCHIVE Alternative behavior proposed by UWSLibrary (but never described in any UWS standard document).
ALWAYS_DELETE Default behavior in UWS-1.0 (and in UWSLibrary).
ARCHIVE_ON_DATE Behavior described in UWS-1.1 about the ARCHIVED phase.

Method Summary

Modifier and Type	Method and Description
static JobDestructionPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JobDestructionPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALWAYS_DELETE

public static final JobDestructionPolicy ALWAYS_DELETE

Default behavior in UWS-1.0 (and in UWSLibrary).

Jobs are ALWAYS immediately destroyed and removed from the JobList.

ARCHIVE_ON_DATE

public static final JobDestructionPolicy ARCHIVE_ON_DATE

Behavior described in UWS-1.1 about the ARCHIVED phase.

Jobs are archived when the destruction date is reached.

The archived jobs are then still in the JobList but in the ExecutionPhase.ARCHIVED phase. An archived job is stopped and all its resources (uploads, results and threads) are freed.

If the destruction date is yet not reached, the job is merely destroyed and removed from the JobList.

Note: Destroying an archived job will definitely destroy it. Thus, the real destruction of a job may be done in 2 steps while using this policy.

ALWAYS_ARCHIVE

public static final JobDestructionPolicy ALWAYS_ARCHIVE

Alternative behavior proposed by UWSLibrary (but never described in any UWS standard document).

Jobs are ALWAYS immediately archived when a destruction is required (either because the destruction is reached or because of an explicit action of the UWS client).

The archived jobs are then still in the JobList but in the ExecutionPhase.ARCHIVED phase. An archived job is stopped and all its resources (uploads, results and threads) are freed.

Note: Destroying an archived job will definitely destroy it. Thus, the real destruction of a job must be done in 2 steps while using this policy.

Method Detail

values

public static JobDestructionPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (JobDestructionPolicy c : JobDestructionPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JobDestructionPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null