uws.service

Interface UWSFactory

All Known Implementing Classes:

AbstractTAPFactory, AbstractUWSFactory, ConfigurableTAPFactory, ConfigurableUWSFactory, TAPFactory, UWSServlet

public interface UWSFactory

Let's creating UWS jobs, their threads and extracting their parameters from HttpServletRequest.

Version:

4.3 (09/2017)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

UWS.getFactory()

Method Summary

Modifier and Type	Method and Description
UWSJob	createJob(javax.servlet.http.HttpServletRequest request, JobOwner user) Creates a (PENDING) UWS job from the given HTTP request.
UWSJob	createJob(java.lang.String jobID, long creationTime, JobOwner owner, UWSParameters params, long quote, long startTime, long endTime, java.util.List<Result> results, ErrorSummary error) Creates a UWS job with the following attributes.
JobThread	createJobThread(UWSJob jobDescription) Creates the thread which will executes the task described by the given UWSJob instance.
RequestParser	createRequestParser(UWSFileManager manager) Create a parser of HTTP requests.
UWSParameters	createUWSParameters(javax.servlet.http.HttpServletRequest request) Lets extracting all parameters from the given request.
UWSParameters	createUWSParameters(java.util.Map<java.lang.String,java.lang.Object> params) Lets extracting all parameters from the given map.

Method Detail

createJob

UWSJob createJob(javax.servlet.http.HttpServletRequest request,
                 JobOwner user)
          throws UWSException

Creates a (PENDING) UWS job from the given HTTP request.

Parameters:

request - Request which triggers the creation of a UWS job.

user - The identified UWS user (see UserIdentifier).

Returns:

The created job.

Throws:

UWSException - If there is an error while creating the job.

createJob

UWSJob createJob(java.lang.String jobID,
                 long creationTime,
                 JobOwner owner,
                 UWSParameters params,
                 long quote,
                 long startTime,
                 long endTime,
                 java.util.List<Result> results,
                 ErrorSummary error)
          throws UWSException

Creates a UWS job with the following attributes.

• note1: This function is mainly used to restore a UWS job at the UWS initialization.
• note2: The job phase is chosen automatically from the given job attributes (i.e. no endTime => PENDING, no result and no error => ABORTED, ...).

Parameters:

jobID - ID of the job (NOT NULL).

creationTime - Creation date/time of the job (SHOULD NOT BE NEGATIVE OR NULL).

owner - Owner of the job.

params - List of all input UWS job parameters.

quote - Its quote (in seconds).

startTime - Date/Time of the start of this job.

endTime - Date/Time of the end of this job.

results - All results of this job.

error - The error which ended the job to create.

Returns:

The created job.

Throws:

UWSException - If there is an error while creating the job.

Since:

4.3

createJobThread

JobThread createJobThread(UWSJob jobDescription)
                   throws UWSException

Creates the thread which will executes the task described by the given UWSJob instance.

Parameters:

jobDescription - Description of the task to execute.

Returns:

The task to execute.

Throws:

UWSException - If there is an error while creating the job task.

createUWSParameters

UWSParameters createUWSParameters(javax.servlet.http.HttpServletRequest request)
                           throws UWSException

Lets extracting all parameters from the given request.

Parameters:

request - The request from which parameters must be extracted.

Returns:

The extracted parameters.

Throws:

UWSException - If an error occurs while extracting parameters.

createUWSParameters

UWSParameters createUWSParameters(java.util.Map<java.lang.String,java.lang.Object> params)
                           throws UWSException

Lets extracting all parameters from the given map.

Parameters:

params - All the parameters to check and to store.

Returns:

The extracted parameters.

Throws:

UWSException - If an error occurs while extracting parameters.

createRequestParser

RequestParser createRequestParser(UWSFileManager manager)
                           throws UWSException

Create a parser of HTTP requests. This object is able to deal with the different formats in which parameters are provided in an HTTP request.

Parameters:

manager - File manager to use if files are uploaded in an HTTP request.

Returns:

The request parser to use.

Throws:

UWSException - If an error occurs while creating the parser.

Since:

4.1