Serialized Form

Package org.json
- Class org.json.JSONException extends java.lang.RuntimeException implements Serializable
  
  serialVersionUID:
  
  0L
- Class org.json.JSONPointerException extends org.json.JSONException implements Serializable
  
  serialVersionUID:
  
  8872944667561856751L
Package uws
- Class uws.ClientAbortException extends java.io.IOException implements Serializable
  
  serialVersionUID:
  
  1L
- 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.config
- Class uws.config.ConfigurableUWSServlet extends javax.servlet.http.HttpServlet implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - uws
```
UWSService uws
```
      UWS object representing the UWS service.
Package uws.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 owner.
    - destructionManager
```
DestructionManager destructionManager
```
      The destruction manager to use to take into account the destructionTime field of contained jobs.
    - destructionPolicy
```
JobDestructionPolicy destructionPolicy
```
      Indicate how this job list behaves when a job destruction is asked.
      By default, a job is always destroyed (i.e. when the destruction is reached but also when a user requested it).
      
      Since:
      
      4.3
    - executionManager
```
ExecutionManager executionManager
```
      This object, if not null, decides whether a managed job can start immediately or must be put in a queue.
    - uws
```
UWS 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
```
UWSJob 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 XLINK URL type (simple (default), extended, locator, arc, resource, title or none ; see http://www.w3.org/TR/xlink/#linking-elements for more details).
    - mimeType
```
java.lang.String mimeType
```
      [Optional] The MIME type of the result.
    - size
```
long size
```
      [Optional] The size of the corresponding result file.
    - redirection
```
boolean redirection
```
      Tells whether a redirection toward the given URL is required to get the result content. If FALSE, the content must be read from the corresponding file managed by the UWSFileManager.
- Class uws.job.SerializableUWSObject extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.job.UWSJob 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 UWSJob.generateJobId(). To change the way this ID is generated or its format you must override this function.
    - creationTime
```
java.util.Date creationTime
```
      Date of the initial creation of this job.
      Note: This attribute can be set only automatically at creation by the UWS service and can not be set or changed by a user (even its owner).
      
      Since:
      
      4.3
    - owner
```
JobOwner 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.
    - myJobList
```
JobList myJobList
```
      The jobs list which is supposed to managed this job.
    - 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.
    - quote
```
long quote
```
      This time predicts when the job is likely to complete.
      It represents the estimated amount of time (in seconds) from the job starting date-time to its successful end.
      
      Note: By default, if no ID is given, UWSJob.quote is set to UWSJob.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.
    - 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.
    - results
```
java.util.Map<K,V> results
```
      This is a list of all results of this job.
    - inputParams
```
UWSParameters inputParams
```
      List of all input parameters (UWS standard and non-standard parameters).
    - jobInfo
```
JobInfo jobInfo
```
      Additional description of this job.
      
      Since:
      
      4.2
    - waitForStop
```
long waitForStop
```
      The time (in ms) to wait the end of the thread after an interruption.
    - observers
```
java.util.Vector<E> observers
```
      Objects which want to be notified at each modification of the execution phase of this job.
    - restorationDate
```
java.util.Date restorationDate
```
      If this job has been restored, this attribute should be set with the date of its restoration.
    - stopping
```
boolean stopping
```
      Used by the thread to known whether the UWSJob.stop() method has already been called, and so, that the job is stopping.
Package uws.job.jobInfo
- Class uws.job.jobInfo.SingleValueJobInfo extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
java.lang.String name
```
      Name of the value stored inside this JobInfo.
      Warning: By default, this name is not supposed to be changed after initialization of this class. That's why only a public getter function is provided.
    - value
```
java.lang.String value
```
      Value stored inside this JobInfo.
    - xmlRepresentation
```
java.lang.String xmlRepresentation
```
      XML representation of this JobInfo, returned by SingleValueJobInfo.getXML(String) and SingleValueJobInfo.write(HttpServletResponse).
      Note: It has to be updated each time the SingleValueJobInfo.value is changed. So by default, it is rebuilt by SingleValueJobInfo.setValue(String).
- Class uws.job.jobInfo.XMLJobInfo extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialization Methods
    - writeObject
```
private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException
```
      Serialize this XMLJobInfo.
      Note: This function will be called by the Java Class Serialization mechanism. See the Javadoc of Serializable for more details.
      
      This function just updates the XML file (if any) location before the normal Java Class Serialization of this object.
      
      Throws:
      
      java.io.IOException - If any error occurs while serializing this XMLJobInfo
  - Serialized Fields
    - location
```
java.lang.String location
```
      XML file location.
      Warning: This field ONLY aims to contain the updated result of file.getLocation().
    - content
```
java.lang.String content
```
      XML document represented by this JobInfo.
      Important: This field MUST be used ONLY for small XML document in order to keep enough memory free for the normal UWS service operations.
      
      Note: It can be set only by XMLJobInfo.XMLJobInfo(String). If set, XMLJobInfo.file must be NULL.
    - length
```
int length
```
      Precise length (in bytes) of the represented XML document.
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
```
UWSJob 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
Package uws.job.parameters
- Class uws.job.parameters.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.job.parameters.DurationParamController extends NumericParamController implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.job.parameters.ExecutionDurationController extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - defaultDuration
```
long defaultDuration
```
      The default duration (in seconds).
    - maxDuration
```
long maxDuration
```
      The maximum duration (in seconds).
    - allowModification
```
boolean allowModification
```
      Indicates whether the execution duration of jobs can be modified.
- Class uws.job.parameters.NumericParamController extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - minValue
```
java.lang.Number minValue
```
      The maximum value.
    - defaultValue
```
java.lang.Number defaultValue
```
      The default value. MUST be between NumericParamController.minValue and NumericParamController.maxValue
    - maxValue
```
java.lang.Number maxValue
```
      The maximum value.
    - allowModification
```
boolean allowModification
```
      Indicates whether the parameter can be modified.
Package uws.job.serializer
- Class uws.job.serializer.JSONSerializer extends UWSSerializer implements Serializable
  
  serialVersionUID:
  
  1L
- 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.UWSServlet extends javax.servlet.http.HttpServlet 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)
    - serializers
```
java.util.Map<K,V> serializers
```
      List of available serializers.
    - defaultSerializer
```
java.lang.String defaultSerializer
```
      The MIME type of the default serialization format.
    - userIdentifier
```
UserIdentifier userIdentifier
```
      The object to use to extract the user ID from the received request.
    - urlInterpreter
```
UWSUrl urlInterpreter
```
      The "interpreter" of UWS URLs.
    - expectedAdditionalParams
```
java.util.ArrayList<E> expectedAdditionalParams
```
      List of all expected additional parameters.
    - inputParamControllers
```
java.util.HashMap<K,V> inputParamControllers
```
      List the controllers of all the input parameters. See UWSParameters and InputParamController for more details.
    - fileManager
```
UWSFileManager fileManager
```
      Lets managing all UWS files (i.e. log, result, backup, ...).
    - backupManager
```
UWSBackupManager backupManager
```
      Lets saving and/or restoring the whole UWS.
    - logger
```
UWSLog logger
```
      Lets logging info/debug/warnings/errors about this UWS.
    - requestParser
```
RequestParser requestParser
```
      Lets extract all parameters from an HTTP request, whatever is its content-type.
      
      Since:
      
      4.1
    - errorWriter
```
ServiceErrorWriter errorWriter
```
      Lets writing/formatting any exception/throwable in a HttpServletResponse.
    - waitPolicy
```
BlockingPolicy waitPolicy
```
      Strategy to use for the blocking/wait process concerning the UWSServlet.doJobSummary(UWSUrl, HttpServletRequest, HttpServletResponse, JobOwner) action.
      If NULL, the standard strategy will be used: wait exactly the time asked by the user (or indefinitely if none is specified).
      
      Since:
      
      4.3
- 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 implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.DestroyJob extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.GetJobParam extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.JobSummary extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.ListJobs extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.SetJobParam extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.SetUWSParameter extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.ShowHomePage extends UWSAction implements Serializable
  
  serialVersionUID:
  
  1L
- Class uws.service.actions.UWSAction extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - uws
```
UWSService uws
```
      The UWS on which this action must be applied.
Package uws.service.file
- Class uws.service.file.UnsupportedURIProtocolException extends UWSException implements Serializable
  
  serialVersionUID:
  
  1L
Package uws.service.wait
- Class uws.service.wait.WaitObserver extends java.lang.Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - waitingThread
```
java.lang.Thread waitingThread
```
      Thread to notify in case an execution phase occurs.

Serialized Form

Package org.json

Class org.json.JSONException extends java.lang.RuntimeException implements Serializable

Class org.json.JSONPointerException extends org.json.JSONException implements Serializable

Package uws

Class uws.ClientAbortException extends java.io.IOException implements Serializable

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

Serialized Fields

httpErrorCode

errorType

Package uws.config

Class uws.config.ConfigurableUWSServlet extends javax.servlet.http.HttpServlet implements Serializable

Serialized Fields

uws

Package uws.job

Class uws.job.ErrorSummary extends SerializableUWSObject implements Serializable

Serialized Fields

message

type

details

Class uws.job.JobList extends SerializableUWSObject implements Serializable

Serialized Fields

name

jobsList

ownerJobs

destructionManager

destructionPolicy

executionManager

uws

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

Serialized Fields

phase

job

Class uws.job.Result extends SerializableUWSObject implements Serializable

Serialized Fields

id

href

type

mimeType

size

redirection

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

Class uws.job.UWSJob extends SerializableUWSObject implements Serializable

Serialized Fields

jobId

creationTime

owner

myJobList

phase

quote

startTime

endTime

errorSummary

results

inputParams

jobInfo

waitForStop

observers

restorationDate

stopping

Package uws.job.jobInfo

Class uws.job.jobInfo.SingleValueJobInfo extends java.lang.Object implements Serializable

Serialized Fields

name

value

xmlRepresentation

Class uws.job.jobInfo.XMLJobInfo extends java.lang.Object implements Serializable

Serialization Methods

writeObject

Serialized Fields

location

content

length

Package uws.job.manager

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

Serialized Fields

jobsToDestroy

currentJob

currentDate

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