uws.job

Enum ExecutionPhase

java.lang.Object

java.lang.Enum<ExecutionPhase>

uws.job.ExecutionPhase

All Implemented Interfaces:

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

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

A job is treated as a state machine where the Execution Phase is the job state. This enum class gathers all Execution Phases declared by the IVOA since UWS-1.1.

The transitions of the state machine described by the IVOA are implemented in a different class: JobPhase.

Version:

4.3 (09/2017)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

JobPhase

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED The job has been manually aborted by the user, or the system has aborted the job due to lack of or overuse of resources.
ARCHIVED At destruction time the results associated with a job have been deleted to free up resource, but the metadata associated with the job have been retained.
COMPLETED The execution of the job is over.
ERROR The job failed to complete.
EXECUTING The job has been assigned to a processor.
HELD The job is HELD pending execution and will not automatically be executed (cf PENDING).
PENDING The job is accepted by the service but not yet committed for execution by the client.
QUEUED The job is committed for execution by the client but the service has not yet assigned it to a processor.
SUSPENDED The job has been suspended by the system during execution.
UNKNOWN The job is in an unknown state.

Method Summary

Modifier and Type	Method and Description
static ExecutionPhase	getPhase(java.lang.String phStr) Get the Execution Phase corresponding to the given label.
static java.lang.String	getStr(ExecutionPhase ph) Get the label of the given Execution Phase.
static ExecutionPhase	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ExecutionPhase[]	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

PENDING

public static final ExecutionPhase PENDING

The job is accepted by the service but not yet committed for execution by the client. In this state, the job quote can be read and evaluated. This is the state into which a job enters when it is first created.

Allowed previous phases: none.

Possible next phases: HELD, QUEUED, ABORTED or ERROR.

QUEUED

public static final ExecutionPhase QUEUED

The job is committed for execution by the client but the service has not yet assigned it to a processor. No Results are produced in this phase.

Allowed previous phases: PENDING or HELD.

Possible next phases: EXECUTING, ABORTED or ERROR.

EXECUTING

public static final ExecutionPhase EXECUTING

The job has been assigned to a processor. Results may be produced at any time during this phase.

Allowed previous phases: QUEUED, HELD or SUSPENDED.

Possible next phases: HELD, SUSPENDED, COMPLETED, ABORTED or ERROR.

COMPLETED

public static final ExecutionPhase COMPLETED

The execution of the job is over. The Results may be collected.

Allowed previous phases: EXECUTING.

Possible next phases: ARCHIVED.

ERROR

public static final ExecutionPhase ERROR

The job failed to complete. No further work will be done nor Results produced. Results may be unavailable or available but invalid; either way the Results should not be trusted.

Allowed previous phases: EXECUTING, QUEUED or PENDING.

Possible next phases: ARCHIVED.

ABORTED

public static final ExecutionPhase ABORTED

The job has been manually aborted by the user, or the system has aborted the job due to lack of or overuse of resources.

Allowed previous phases: PENDING, QUEUED, EXECUTING, HELD or SUSPENDED.

Possible next phases: ARCHIVED.

UNKNOWN

public static final ExecutionPhase UNKNOWN

The job is in an unknown state.

Note: If the UWS reports an UNKNOWN phase, then all the client can do is re-query the phase until a known phase is reported.

Allowed previous phases: any.

Possible next phases: any.

HELD

public static final ExecutionPhase HELD

The job is HELD pending execution and will not automatically be executed (cf PENDING).

Note: A UWS may place a job in a HELD phase on receipt of a PHASE=RUN request if for some reason the job cannot be immediately queued - in this case it is the responsibility of the client to request PHASE=RUN again at some later time.

Allowed previous phases: PENDING or EXECUTING.

Possible next phases: QUEUED, EXECUTING, ABORTED or ERROR.

SUSPENDED

public static final ExecutionPhase SUSPENDED

The job has been suspended by the system during execution. This might be because of temporary lack of resource. The UWS will automatically resume the job into the EXECUTING phase without any intervention when resource becomes available.

Allowed previous phases: EXECUTING.

Possible next phases: EXECUTING, ABORTED or ERROR.

ARCHIVED

public static final ExecutionPhase ARCHIVED

At destruction time the results associated with a job have been deleted to free up resource, but the metadata associated with the job have been retained. This is an alternative that the server may choose in contrast to completely destroying all record of the job to allow a longer historical record of the existence of the job to be kept that would otherwise be the case if limited result storage resources forces destruction.

Allowed previous phases: ABORTED, COMPLETED or ERROR.

Possible next phases: none.

Since:

4.3

Method Detail

values

public static ExecutionPhase[] 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 (ExecutionPhase c : ExecutionPhase.values())
    System.out.println(c);

Returns:

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

valueOf

public static ExecutionPhase 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

getStr

public static final java.lang.String getStr(ExecutionPhase ph)

Get the label of the given Execution Phase.

Note: The reverse operation is getPhase(String).

Parameters:

ph - An Execution Phase.

Returns:

The label of the given phase, or UNKNOWN if NULL is given.

getPhase

public static final ExecutionPhase getPhase(java.lang.String phStr)

Get the Execution Phase corresponding to the given label.

Note: The reverse operation is getStr(ExecutionPhase).

Parameters:

phStr - Label of the Execution Phase to resolve.

Returns:

The corresponding ExecutionPhase, or UNKNOWN if the given String is NULL or does not match any legal Execution Phase.