Serialized Form

Package uws

Class uws.UWSException extends java.lang.Exception implements Serializable

serialVersionUID: 1L

Serialized Fields

httpErrorCode

int httpErrorCode

The HTTP error code (by default NOT_FOUND). It MUST BE greater than 0.

errorType

ErrorType errorType

The UWS error type (by default FATAL). It MUST BE non null.

Package uws.job

Class uws.job.AbstractJob extends SerializableUWSObject implements Serializable

serialVersionUID: 1L

Serialized Fields

jobId

java.lang.String jobId

The identifier of the job (it MUST be different from any other job).
Note: It is assigned automatically at the job creation in any job constructor by the function AbstractJob.generateJobId(). To change the way this ID is generated or its format you must override this function.

owner

java.lang.String owner

The identifier of the creator of this job.
Note: This object will not exist for all invocations of the UWS conformant protocol, but only in cases where the access to the service is authenticated.

runId

java.lang.String runId

The name/label that the job creator uses to identify this job.
Note: this is distinct from the Job Identifier that the UWS system itself assigns to each job (AbstractJob.jobId). It may not be unique !

phase

JobPhase phase

The current phase of the job.

Remember: A job is treated as a state machine thanks to this attribute.

• A successful job will normally progress through the PENDING, QUEUED, EXECUTING, COMPLETED phases in that order.
• At any time before the COMPLETED phase a job may either be ABORTED or may suffer an ERROR.
• If the UWS reports an UNKNOWN phase, then all the client can do is re-query the phase until a known phase is reported.
• A UWS may place a job in a HELD phase on receipt of a PHASE=RUN request it 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.

dateFormat

java.text.DateFormat dateFormat

The used date formatter.

quote

long quote

This time (in seconds) predicts when the job is likely to complete.
It CAN NOT be changed after the job creation !
By default if no ID is given, AbstractJob.quote is set to AbstractJob.QUOTE_NOT_KNOWN (= -1L).

startTime

java.util.Date startTime

The time at which the job execution started.

endTime

java.util.Date endTime

The time at which the job execution ended.

executionDuration

long executionDuration

This is the duration (in seconds) for which the job shall run.

Notes:

• An execution duration of 0 (AbstractJob.UNLIMITED_DURATION) implies unlimited execution duration.
• When a job is created, the service sets the initial execution duration.
• When the execution duration has been exceeded the service should automatically abort the job, which has the same effect as when a manual "Abort" is requested.

destructionTime

java.util.Date destructionTime

This represents the instant when the job shall be destroyed.

Notes: Destroying a job implies:

• if the job is still executing, the execution is aborted
• any results from the job are destroyed and storage reclaimed
• the service forgets that the job existed.

The Destruction time should be viewed as a measure of the amount of time that a service is prepared to allocated storage for a job - typically this will be a longer duration that the amount of CPU time that a service would allocate.

errorSummary

ErrorSummary errorSummary

This error summary gives a human-readable error message for the underlying job.

Note: This object is intended to be a detailed error message, and consequently, might be a large piece of text such as a stack trace.

additionalParameters

java.util.Map<K,V> additionalParameters

This is an enumeration of the other Job parameters (given in POST queries).

results

java.util.List<E> results

This is a list of all results of this job.

waitForStop

long waitForStop

The time to wait the end of the thread after an interruption.

executionManager

ExecutionManager executionManager

This object, if not null, decides whether this job can start immediately or must be put in a queue.

myJobList

JobList<J extends AbstractJob> myJobList

The jobs list which is supposed to managed this job.

observers

java.util.Vector<E> observers

Objects which want to be notified at each modification of the execution phase of this job.

Class uws.job.ErrorSummary extends SerializableUWSObject implements Serializable

serialVersionUID: 1L

Serialized Fields

message

java.lang.String message

[Required] A short description of the error.

type

ErrorType type

[Required] The type of the error.

details

java.lang.String details

[Optional] The URI/URL toward the file which contains a more detailed description of the error (i.e. an Exception stack trace).

Class uws.job.JobList extends SerializableUWSObject implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

[Required] Name of the jobs list.

jobsList

java.util.Map<K,V> jobsList

[Required] List of jobs.

ownerJobs

java.util.Map<K,V> ownerJobs

[Required] List of jobs per ownerId/userId.

destructionManager

DestructionManager destructionManager

[Optional] The destruction manager to use to take into account the destructionTime field of contained jobs.

uws

AbstractUWS<JL extends JobList<J>,J extends AbstractJob> uws

[Optional] Useful only to get the URL of this job list.

Class uws.job.JobPhase extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

phase

ExecutionPhase phase

Current phase of the associated job.

job

AbstractJob job

The job whose the current phase is represented by this class.

Class uws.job.Result extends SerializableUWSObject implements Serializable

serialVersionUID: 1L

Serialized Fields

id

java.lang.String id

[Required ; Default="result"] Name or ID of this result.

href

java.lang.String href

[Optional] The readable URL which points toward the result file.

type

java.lang.String type

[Optional] The type of result.

Class uws.job.SerializableUWSObject extends java.lang.Object implements Serializable

serialVersionUID: 1L

Package uws.job.manager

Class uws.job.manager.DefaultDestructionManager extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

jobsToDestroy

java.util.TreeSet<E> jobsToDestroy

The list of jobs to destroy. Jobs are sorted by ascending destruction time thanks to DefaultDestructionManager.TimeComparator.

currentJob

AbstractJob currentJob

The job currently planned for destruction. This job will be destroyed by the timer timDestruction.

currentDate

java.util.Date currentDate

The date used by the timer to trigger the destruction of DefaultDestructionManager.currentJob.

Class uws.job.manager.DefaultDestructionManager.TimeComparator extends java.lang.Object implements Serializable

serialVersionUID: 1L

Class uws.job.manager.DefaultExecutionManager extends java.lang.Object implements Serializable

serialVersionUID: 1L

Class uws.job.manager.QueuedExecutionManager extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

nbMaxRunningJobs

int nbMaxRunningJobs

The maximum number of running jobs.

Package uws.job.serializer

Class uws.job.serializer.JSONSerializer extends UWSSerializer implements Serializable

serialVersionUID: 1L

Serialized Fields

tabPrefix

java.lang.String tabPrefix

Tab to use just before a JSON item.

Class uws.job.serializer.UWSSerializer extends java.lang.Object implements Serializable

serialVersionUID: 1L

Class uws.job.serializer.XMLSerializer extends UWSSerializer implements Serializable

serialVersionUID: 1L

Serialized Fields

tabPrefix

java.lang.String tabPrefix

Tab to add just before each next XML node.

xsltPath

java.lang.String xsltPath

The path of the XSLT style-sheet.

Package uws.service

Class uws.service.AbstractUWS extends SerializableUWSObject implements Serializable

serialVersionUID: 1L

Serialized Fields

name

java.lang.String name

Name of this UWS.

description

java.lang.String description

Description of this UWS.

mapJobLists

java.util.Map<K,V> mapJobLists

List of all managed jobs lists. (it is a LinkedHashMap so that jobs lists are ordered by insertion)

urlInterpreter

UWSUrl urlInterpreter

The "interpreter" of UWS URLs.

reInitUrlInterpreter

boolean reInitUrlInterpreter

Indicates whether the UWS URL interpreter must be re-initialize after each de-serialization.

serializers

java.util.Map<K,V> serializers

List of available serializers.

defaultSerializer

java.lang.String defaultSerializer

The MIME type of the default serialization format.

choosenSerializer

UWSSerializer choosenSerializer

The serializer choosen during the last call of AbstractUWS.executeRequest(HttpServletRequest, HttpServletResponse).

homePage

java.lang.String homePage

URL of the home page. (NULL if there is no home page)

homeRedirection

boolean homeRedirection

Indicates whether the home page must be a copy or a redirection to the given URL.

durationController

ExecutionDurationController durationController

Lets controlling the execution duration of all managed jobs.

destructionController

DestructionTimeController destructionController

Lets controlling the destruction time of all managed jobs.

uwsActions

java.util.Vector<E> uwsActions

List of UWS actions (i.e. to list jobs, to get a job, to set a job parameter, etc...).

executedAction

UWSAction<JL extends JobList<J>,J extends AbstractJob> executedAction

The action executed during the last call of AbstractUWS.executeRequest(HttpServletRequest, HttpServletResponse).

userIdentifier

UserIdentifier userIdentifier

The object to use to extract the user ID from the received request.

destructionManager

DestructionManager destructionManager

Lets managing the automatic destruction of all managed jobs, whatever is their jobs list.

executionManager

ExecutionManager executionManager

Lets managing the execution queue and all the executing jobs.

Class uws.service.BasicUWS extends AbstractUWS<JobList<J extends AbstractJob>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Serialized Fields

jobClass

java.lang.Class<T> jobClass

The class object of the type of job to manage.

Class uws.service.ExtendedUWS extends AbstractUWS<JobList<AbstractJob>,AbstractJob> implements Serializable

serialVersionUID: 1L

Serialized Fields

assocJobListClass

java.util.Map<K,V> assocJobListClass

Association between each JobList and the class object of the type of job that this JobList manages.

jlDestination

JobList<J extends AbstractJob> jlDestination

Current JobList. (ALWAYS null EXCEPT WHILE ADDING A JOB !!)

Class uws.service.ExtendedUWS.AddJobWithConstructor extends AddJob<JobList<AbstractJob>,AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.QueuedBasicUWS extends BasicUWS<J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.QueuedExtendedUWS extends ExtendedUWS implements Serializable

serialVersionUID: 1L

Class uws.service.UWSUrl extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

requestURL

java.lang.String requestURL

The whole request URL (i.e. http://foo.org/mySite/uws/jobList/job1/results/report).

urlHeader

java.lang.String urlHeader

The URL prefix (i.e. http://foo.org/mySite).

requestURI

java.lang.String requestURI

The request URI (i.e. /uws/jobList/job1/results/report)

baseURI

java.lang.String baseURI

Base UWS URI (i.e. /uws).

uwsURI

java.lang.String uwsURI

The URI from the base UWS URI (i.e. /jobList/job1/results/report).

jobListName

java.lang.String jobListName

Name of a jobs list found in uwsURI (i.e. jobList).

jobId

java.lang.String jobId

The JobID found in uwsURI (i.e. job1).

attributes

java.lang.String[] attributes

Name of the job attribute found in uwsURI (i.e. {results, report}).

Package uws.service.actions

Class uws.service.actions.AddJob extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.DestroyJob extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.GetJobParam extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.JobSummary extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.ListJobs extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.SetJobParam extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.ShowHomePage extends UWSAction<JL extends JobList<J>,J extends AbstractJob> implements Serializable

serialVersionUID: 1L

Class uws.service.actions.UWSAction extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

uws

AbstractUWS<JL extends JobList<J>,J extends AbstractJob> uws

The UWS on which this action must be applied.

Package uws.service.controller

Class uws.service.controller.DestructionTimeController extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

defaultTime

java.util.Date defaultTime

The default destruction time.

defaultIntervalField

DestructionTimeController.DateField defaultIntervalField

The date-time field on which the default interval applies.

defaultInterval

int defaultInterval

The default interval from the initialization to the destruction of the concerned job.

maxTime

java.util.Date maxTime

The maximum destruction time.

maxIntervalField

DestructionTimeController.DateField maxIntervalField

The date-time field on which the maximum interval applies.

maxInterval

int maxInterval

The maximum interval from the initialization to the destruction of the concerned job.

allowModification

boolean allowModification

Indicates whether the destruction time of jobs can be modified.

Class uws.service.controller.ExecutionDurationController extends java.lang.Object implements Serializable

serialVersionUID: 1L

Serialized Fields

defaultDuration

long defaultDuration

The default duration.

maxDuration

long maxDuration

The maximum duration.

allowModification

boolean allowModification

Indicates whether the execution duration of jobs can be modified.