UWSServlet

java.lang.Object
- javax.servlet.GenericServlet
- - javax.servlet.http.HttpServlet
  - - uws.service.UWSServlet

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<JobList>, javax.servlet.Servlet, javax.servlet.ServletConfig, UWS, UWSFactory
```
public abstract class UWSServlet
extends javax.servlet.http.HttpServlet
implements UWS, UWSFactory
```
This servlet lets initialize and manage a web service implementing the UWS pattern. That's to say all methods and functionalities of a UWS are already implemented. All you have to do is to initialize and maybe to customize your UWS.

UWS Definition

To create a such servlet, you have to extend this class. Once done, only two functions must be implemented: createJob(HttpServletRequest, JobOwner) and initUWS().

The first one will be called by the library each time a job must be created. All the job parameters given by the user and the identity of the user are given in the arguments. You just have to return an appropriate instance of a job using all these information.

initUWS() must contain at least one line: the creation of a job list. For instance:
addJobList(new JobList<MyJob>("jlName"));
The below code show an example of usage of this class:
```
 public class MyUWSServlet extends UWSServlet {

        // Initialize the UWS service by creating at least one job list.
        public void initUWS() throws UWSException {
                addJobList(new JobList("jobList"));
        }

        // Create the job process corresponding to the job to execute ; generally, the process identification can be merely done by checking the job list name.
        public JobThread createJobThread(UWSJob job) throws UWSException {
                if (job.getJobList().getName().equals("jobList"))
                        return new MyJobThread(job);
                else
                        throw new UWSException("Impossible to create a job inside the jobs list \"" + job.getJobList().getName() + "\" !");
        }
 }
 
```
The name and the description of the UWS may be specified in the web.xml file as init-param of the servlet: name and description. The other way is to directly set the corresponding attributes: name and description.

Note: If any error occurs while the initialization or the creation of a UWSServlet instance, a ServletException will be thrown with a basic message dedicated to the service users. This basic and non-informative message is obviously not intended to the administrator which will be able to get the reason of the failure (with a stack trace when available) in the log files.

UWS customization

As for the classic HTTP servlets, this servlet has one method for each method of the implemented protocol. Thus, you have one function for the "add job" action, another one for the "get job list" action, ... These functions are:
They are all already implemented following their definition in the IVOA document. However, if needed, they can be overridden in order to do your own actions.

Besides, the classic HTTP servlet methods (i.e. HttpServlet.doGet(HttpServletRequest, HttpServletResponse), HttpServlet.doPost(HttpServletRequest, HttpServletResponse), ...) are called normally if none of the UWS actions match to the received HTTP request. So, they can be overridden as in any HTTP servlet.
Version:

4.4 (08/2018)

Author:

Grégory Mantelet (CDS;ARI)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected UWSBackupManager`	`backupManager` Lets saving and/or restoring the whole UWS.
`protected java.lang.String`	`defaultSerializer` The MIME type of the default serialization format.
`protected java.lang.String`	`description` Description of this UWS.
`protected ServiceErrorWriter`	`errorWriter` Lets writing/formatting any exception/throwable in a HttpServletResponse.
`protected java.util.ArrayList<java.lang.String>`	`expectedAdditionalParams` List of all expected additional parameters.
`protected java.util.HashMap<java.lang.String,InputParamController>`	`inputParamControllers` List the controllers of all the input parameters.
`protected static java.lang.String`	`lastRequestID`
`protected UWSLog`	`logger` Lets logging info/debug/warnings/errors about this UWS.
`protected java.lang.String`	`name` Name of this UWS.
`protected RequestParser`	`requestParser` Lets extract all parameters from an HTTP request, whatever is its content-type.
`protected UserIdentifier`	`userIdentifier` The object to use to extract the user ID from the received request.
`protected BlockingPolicy`	`waitPolicy` Strategy to use for the blocking/wait process concerning the `doJobSummary(UWSUrl, HttpServletRequest, HttpServletResponse, JobOwner)` action.

Fields inherited from interface uws.service.UWS
REQ_ATTRIBUTE_ID, REQ_ATTRIBUTE_JOB_DESCRIPTION, REQ_ATTRIBUTE_PARAMETERS, REQ_ATTRIBUTE_USER, STANDARD_ID, VERSION

Constructor Summary

Constructors
Constructor and Description

UWSServlet()

Constructors
Constructor and Description
`UWSServlet()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExpectedAdditionalParameter(java.lang.String paramName)` Adds the name of an additional parameter which must be identified without taking into account its case and then stored with the case of the given name.
`boolean`	`addJobList(JobList jl)` Adds a jobs list to this UWS.
`boolean`	`addSerializer(UWSSerializer serializer)` Adds a serializer to this UWS
`void`	`configureDestruction(int defaultTime, DestructionTimeController.DateField defaultTimeUnit, int maxTime, DestructionTimeController.DateField maxTimeUnit, boolean allowModif)` Lets configuring the destruction time default and maximum value.
`void`	`configureExecution(long defaultDuration, long maxDuration, boolean allowModif)` Lets configuring the execution duration default and maximum value.
`UWSFileManager`	`createFileManager()`
`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.
`RequestParser`	`createRequestParser(UWSFileManager fileManager)` Create a parser of HTTP requests.
`UWSParameters`	`createUWSParameters(javax.servlet.http.HttpServletRequest req)` 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.
`void`	`destroy()` End properly this UWS: jobs should be backuped (if this feature is enable), timers and threads should be stopped, open files and database connections should be closed, etc...
`boolean`	`destroyJobList(JobList jl)` Destroys the given jobs list.
`boolean`	`destroyJobList(java.lang.String name)` Destroys the specified jobs list.
`protected void`	`doAddJob(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`protected void`	`doDestroyJob(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`protected void`	`doGetJobParam(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`protected void`	`doJobSummary(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`protected void`	`doListJob(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`protected void`	`doSetJobParam(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`protected void`	`doSetUWSParameter(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`
`java.util.Iterator<java.lang.String>`	`expectedAdditionalParametersIterator()` Gets an iterator on the names of the expected additional parameters.
`protected java.lang.String`	`generateRequestID(javax.servlet.http.HttpServletRequest request)`
`UWSBackupManager`	`getBackupManager()` Gets its backup manager.
`java.lang.String`	`getDescription()` Gets the description of this UWS.
`ServiceErrorWriter`	`getErrorWriter()` Gets the object used to write/format any error in a HttpServletResponse.
`java.util.List<java.lang.String>`	`getExpectedAdditionalParameters()` Gets the names of the expected additional parameters.
`UWSFactory`	`getFactory()` Gets its job factory.
`UWSFileManager`	`getFileManager()` Gets its file manager.
`InputParamController`	`getInputParamController(java.lang.String inputParamName)` Gets the controller of the specified UWS input parameter.
`java.util.Map<java.lang.String,InputParamController>`	`getInputParamControllers()` Gets the list of all UWS input parameter controllers.
`java.util.Iterator<java.util.Map.Entry<java.lang.String,InputParamController>>`	`getInputParamControllersIterator()` Gets an iterator on the list of all UWS input parameter controllers.
`UWSJob`	`getJob(UWSUrl requestUrl)`
`UWSJob`	`getJob(UWSUrl requestUrl, JobOwner user)`
`JobList`	`getJobList(java.lang.String name)` Gets the jobs list whose the name matches exactly the given one.
`UWSLog`	`getLogger()` Gets the logger of this UWS.
`java.lang.String`	`getName()` Gets the name of this UWS.
`int`	`getNbExpectedAdditionalParameters()` Gets the number of additional parameters which must be identified with no case sensitivity.
`int`	`getNbJobList()` Gets the number of managed jobs lists.
`RequestParser`	`getRequestParser()` Get its HTTP request parser.
`UWSSerializer`	`getSerializer(java.lang.String mimeTypes)` Gets the serializer whose the MIME type is the same as the given one.
`UWSUrl`	`getUrlInterpreter()` Gets the UWS URL interpreter of this UWS.
`UserIdentifier`	`getUserIdentifier()` Gets the object which lets extracting the user ID from a HTTP request.
`BlockingPolicy`	`getWaitPolicy()` Get the currently used strategy for the blocking behavior of the Job Summary action.
`java.lang.String`	`getXsltURL()` Gets the URL of the XSLT style-sheet that the XML serializer of this UWS is using.
`void`	`init()`
`void`	`init(javax.servlet.ServletConfig config)`
`abstract void`	`initUWS()`
`java.util.Iterator<JobList>`	`iterator()`
`void`	`redirect(java.lang.String url, javax.servlet.http.HttpServletRequest request, JobOwner user, java.lang.String uwsAction, javax.servlet.http.HttpServletResponse response)` Sends a redirection (with the HTTP status code 303) to the given URL/URI into the given response.
`void`	`removeExpectedAdditionalParam(java.lang.String paramName)` Removes the name of an expected additional parameter.
`InputParamController`	`removeInputParamController(java.lang.String paramName)` Removes the controller of the specified input UWS job parameter.
`UWSSerializer`	`removeSerializer(java.lang.String mimeType)` Removes the serializer whose the MIME type is the same as the given one.
`void`	`sendError(java.lang.Throwable error, javax.servlet.http.HttpServletRequest request, java.lang.String reqID, JobOwner user, java.lang.String uwsAction, javax.servlet.http.HttpServletResponse response)` Fills the response with the given error.
`void`	`sendError(UWSException error, javax.servlet.http.HttpServletRequest request, java.lang.String reqID, JobOwner user, java.lang.String uwsAction, javax.servlet.http.HttpServletResponse response)` Fills the response with the given error.
`protected void`	`service(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)`
`void`	`service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp)`
`void`	`setErrorWriter(ServiceErrorWriter errorWriter)` Sets the object used to write/format any error in a HttpServletResponse.
`InputParamController`	`setInputParamController(java.lang.String paramName, InputParamController controller)` Sets the controller of the specified input UWS job parameter.
`void`	`setUrlInterpreter(UWSUrl urlInterpreter)` Sets the UWS URL interpreter to use in this UWS.
`void`	`setUserIdentifier(UserIdentifier identifier)` Sets the object which lets extracting the use ID from a received request.
`void`	`setWaitPolicy(BlockingPolicy waitPolicy)` Set the strategy to use for the blocking behavior of the Job Summary action.
`boolean`	`setXsltURL(java.lang.String xsltPath)` Sets the URL of the XSLT style-sheet that the XML serializer of this UWS must use.
`protected void`	`writeHomePage(UWSUrl requestUrl, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp, JobOwner user)`

Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified

Methods inherited from class javax.servlet.GenericServlet
getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface uws.service.UWSFactory
createJobThread

- Field Detail
  - name
```
protected java.lang.String name
```
    Name of this UWS.
  - description
```
protected java.lang.String description
```
    Description of this UWS.
  - defaultSerializer
```
protected java.lang.String defaultSerializer
```
    The MIME type of the default serialization format.
  - userIdentifier
```
protected UserIdentifier userIdentifier
```
    The object to use to extract the user ID from the received request.
  - expectedAdditionalParams
```
protected final java.util.ArrayList<java.lang.String> expectedAdditionalParams
```
    List of all expected additional parameters.
  - inputParamControllers
```
protected final java.util.HashMap<java.lang.String,InputParamController> inputParamControllers
```
    List the controllers of all the input parameters. See UWSParameters and InputParamController for more details.
  - backupManager
```
protected UWSBackupManager backupManager
```
    Lets saving and/or restoring the whole UWS.
  - logger
```
protected UWSLog logger
```
    Lets logging info/debug/warnings/errors about this UWS.
  - requestParser
```
protected RequestParser requestParser
```
    Lets extract all parameters from an HTTP request, whatever is its content-type.
    
    Since:
    
    4.1
  - errorWriter
```
protected ServiceErrorWriter errorWriter
```
    Lets writing/formatting any exception/throwable in a HttpServletResponse.
  - waitPolicy
```
protected BlockingPolicy waitPolicy
```
    Strategy to use for the blocking/wait process concerning the 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
  - lastRequestID
```
protected static java.lang.String lastRequestID
```
- Constructor Detail
  - UWSServlet
```
public UWSServlet()
```
- Method Detail
  - init
```
public final void init(javax.servlet.ServletConfig config)
                throws javax.servlet.ServletException
```
    Specified by:
    
    init in interface javax.servlet.Servlet
    
    Overrides:
    
    init in class javax.servlet.GenericServlet
    
    Throws:
    
    javax.servlet.ServletException
  - init
```
public final void init()
                throws javax.servlet.ServletException
```
    Overrides:
    
    init in class javax.servlet.GenericServlet
    
    Throws:
    
    javax.servlet.ServletException
  - initUWS
```
public abstract void initUWS()
                      throws UWSException
```
    Throws:
    
    UWSException
  - destroy
```
public void destroy()
```
    Description copied from interface: UWS
    
    End properly this UWS: jobs should be backuped (if this feature is enable), timers and threads should be stopped, open files and database connections should be closed, etc... In brief, this function should release all used resources.
    
    IMPORTANT: This function should be called only when the JVM or the Web Application Server is stopping.
    
    Note: A call to this function may prevent this instance of UWS to execute any subsequent HTTP request, or the behavior would be unpredictable.
    
    Specified by:
    
    destroy in interface javax.servlet.Servlet
    
    Specified by:
    
    destroy in interface UWS
    
    Overrides:
    
    destroy in class javax.servlet.GenericServlet
  - createFileManager
```
public UWSFileManager createFileManager()
                                 throws UWSException
```
    Throws:
    
    UWSException
  - getFileManager
```
public UWSFileManager getFileManager()
```
    Description copied from interface: UWS
    
    Gets its file manager.
    
    note: A file manager tells to a UWS how to create, read and write the different managed files (i.e. log, result, errors, backup). A default implementation is available: LocalUWSFileManager.
    
    Specified by:
    
    getFileManager in interface UWS
    
    Returns:
    
    Its file manager.
  - getRequestParser
```
public RequestParser getRequestParser()
```
    Description copied from interface: UWS
    
    Get its HTTP request parser.
    
    note: This parser is the only one to be able to extract UWS and TAP parameters from any HTTP request. Its behavior is adapted in function of the used HTTP method and of the content-type. A default implementation is provided by the UWS library: UWSRequestParser.
    
    Specified by:
    
    getRequestParser in interface UWS
    
    Returns:
    
    Its request parser.
  - service
```
public final void service(javax.servlet.ServletRequest req,
                          javax.servlet.ServletResponse resp)
                   throws javax.servlet.ServletException,
                          java.io.IOException
```
    Specified by:
    
    service in interface javax.servlet.Servlet
    
    Overrides:
    
    service in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    java.io.IOException
  - generateRequestID
```
protected java.lang.String generateRequestID(javax.servlet.http.HttpServletRequest request)
```
  - service
```
protected final void service(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp)
                      throws javax.servlet.ServletException,
                             java.io.IOException
```
    Overrides:
    
    service in class javax.servlet.http.HttpServlet
    
    Throws:
    
    javax.servlet.ServletException
    
    java.io.IOException
  - getWaitPolicy
```
public final BlockingPolicy getWaitPolicy()
```
    Get the currently used strategy for the blocking behavior of the Job Summary action.
    This strategy lets decide how long a WAIT request must block a HTTP request. With a such policy, the waiting time specified by the user may be modified.
    
    Returns:
    
    The WAIT strategy, or NULL if the default one (i.e. wait the time specified by the user) is used.
    
    Since:
    
    4.3
  - setWaitPolicy
```
public final void setWaitPolicy(BlockingPolicy waitPolicy)
```
    Set the strategy to use for the blocking behavior of the Job Summary action.
    This strategy lets decide whether a WAIT request must block a HTTP request and how long. With a such policy, the waiting time specified by the user may be modified.
    
    Parameters:
    
    waitPolicy - The WAIT strategy to use, or NULL if the default one (i.e. wait the time specified by the user ; if no time is specified the HTTP request may be blocked indefinitely) must be used.
    
    Since:
    
    4.3
  - writeHomePage
```
protected void writeHomePage(UWSUrl requestUrl,
                             javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp,
                             JobOwner user)
                      throws UWSException,
                             javax.servlet.ServletException,
                             java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doListJob
```
protected void doListJob(UWSUrl requestUrl,
                         javax.servlet.http.HttpServletRequest req,
                         javax.servlet.http.HttpServletResponse resp,
                         JobOwner user)
                  throws UWSException,
                         javax.servlet.ServletException,
                         java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doAddJob
```
protected void doAddJob(UWSUrl requestUrl,
                        javax.servlet.http.HttpServletRequest req,
                        javax.servlet.http.HttpServletResponse resp,
                        JobOwner user)
                 throws UWSException,
                        javax.servlet.ServletException,
                        java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doSetUWSParameter
```
protected void doSetUWSParameter(UWSUrl requestUrl,
                                 javax.servlet.http.HttpServletRequest req,
                                 javax.servlet.http.HttpServletResponse resp,
                                 JobOwner user)
                          throws UWSException,
                                 javax.servlet.ServletException,
                                 java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doDestroyJob
```
protected void doDestroyJob(UWSUrl requestUrl,
                            javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp,
                            JobOwner user)
                     throws UWSException,
                            javax.servlet.ServletException,
                            java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doJobSummary
```
protected void doJobSummary(UWSUrl requestUrl,
                            javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse resp,
                            JobOwner user)
                     throws UWSException,
                            javax.servlet.ServletException,
                            java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doGetJobParam
```
protected void doGetJobParam(UWSUrl requestUrl,
                             javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp,
                             JobOwner user)
                      throws UWSException,
                             javax.servlet.ServletException,
                             java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - doSetJobParam
```
protected void doSetJobParam(UWSUrl requestUrl,
                             javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse resp,
                             JobOwner user)
                      throws UWSException,
                             javax.servlet.ServletException,
                             java.io.IOException
```
    Throws:
    
    UWSException
    
    javax.servlet.ServletException
    
    java.io.IOException
  - getJob
```
public UWSJob getJob(UWSUrl requestUrl)
              throws UWSException
```
    Throws:
    
    UWSException
  - getJob
```
public UWSJob getJob(UWSUrl requestUrl,
                     JobOwner user)
              throws UWSException
```
    Throws:
    
    UWSException
  - getFactory
```
public final UWSFactory getFactory()
```
    Description copied from interface: UWS
    
    Gets its job factory.
    
    note: This objects is the only one to know how to extract job parameters from an HTTP request, how to create a job and how to create its respective thread. A partial implementation which answers to the 2 first questions is available: AbstractUWSFactory
    
    Specified by:
    
    getFactory in interface UWS
    
    Returns:
    
    Its job factory.
  - createJob
```
public UWSJob createJob(javax.servlet.http.HttpServletRequest request,
                        JobOwner user)
                 throws UWSException
```
    Description copied from interface: UWSFactory
    
    Creates a (PENDING) UWS job from the given HTTP request.
    
    Specified by:
    
    createJob in interface UWSFactory
    
    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
```
public 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
```
    Description copied from interface: UWSFactory
    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, ...).
    Specified by:
    
    createJob in interface UWSFactory
    
    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.
  - createUWSParameters
```
public UWSParameters createUWSParameters(java.util.Map<java.lang.String,java.lang.Object> params)
                                  throws UWSException
```
    Description copied from interface: UWSFactory
    
    Lets extracting all parameters from the given map.
    
    Specified by:
    
    createUWSParameters in interface UWSFactory
    
    Parameters:
    
    params - All the parameters to check and to store.
    
    Returns:
    
    The extracted parameters.
    
    Throws:
    
    UWSException - If an error occurs while extracting parameters.
  - createUWSParameters
```
public UWSParameters createUWSParameters(javax.servlet.http.HttpServletRequest req)
                                  throws UWSException
```
    Description copied from interface: UWSFactory
    
    Lets extracting all parameters from the given request.
    
    Specified by:
    
    createUWSParameters in interface UWSFactory
    
    Parameters:
    
    req - The request from which parameters must be extracted.
    
    Returns:
    
    The extracted parameters.
    
    Throws:
    
    UWSException - If an error occurs while extracting parameters.
  - createRequestParser
```
public RequestParser createRequestParser(UWSFileManager fileManager)
                                  throws UWSException
```
    Description copied from interface: UWSFactory
    
    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.
    
    Specified by:
    
    createRequestParser in interface UWSFactory
    
    Parameters:
    
    fileManager - 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.
  - redirect
```
public void redirect(java.lang.String url,
                     javax.servlet.http.HttpServletRequest request,
                     JobOwner user,
                     java.lang.String uwsAction,
                     javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     java.io.IOException
```
    Sends a redirection (with the HTTP status code 303) to the given URL/URI into the given response.
    
    Parameters:
    
    url - The redirection URL/URI.
    
    request - The HttpServletRequest which may be used to make a redirection.
    
    response - The HttpServletResponse which must contain all information to make a redirection.
    
    Throws:
    
    java.io.IOException - If there is an error during the redirection.
    
    UWSException - If there is any other error.
    
    javax.servlet.ServletException
  - sendError
```
public final void sendError(UWSException error,
                            javax.servlet.http.HttpServletRequest request,
                            java.lang.String reqID,
                            JobOwner user,
                            java.lang.String uwsAction,
                            javax.servlet.http.HttpServletResponse response)
                     throws javax.servlet.ServletException
```
    Fills the response with the given error. The HTTP status code is set in function of the error code of the given UWSException. If the error code is UWSException.SEE_OTHER this method calls redirect(String, HttpServletRequest, JobOwner, String, HttpServletResponse). Otherwise the function HttpServletResponse.sendError(int, String) is called.
    
    Parameters:
    
    error - The error to send/display.
    
    request - The request which has caused the given error (not used by default).
    
    reqID - ID of the request.
    
    user - The user which executes the given request.
    
    uwsAction - The UWS action corresponding to the given request.
    
    response - The response in which the error must be published.
    
    Throws:
    
    java.io.IOException - If there is an error when calling redirect(String, HttpServletRequest, JobOwner, String, HttpServletResponse) or HttpServletResponse.sendError(int, String).
    
    UWSException - If there is an error when calling redirect(String, HttpServletRequest, JobOwner, String, HttpServletResponse).
    
    javax.servlet.ServletException
    
    See Also:
    
    redirect(String, HttpServletRequest, JobOwner, String, HttpServletResponse), sendError(Throwable, HttpServletRequest, String, JobOwner, String, HttpServletResponse)
  - sendError
```
public final void sendError(java.lang.Throwable error,
                            javax.servlet.http.HttpServletRequest request,
                            java.lang.String reqID,
                            JobOwner user,
                            java.lang.String uwsAction,
                            javax.servlet.http.HttpServletResponse response)
                     throws javax.servlet.ServletException
```
    Fills the response with the given error. The stack trace of the error is printed on the standard output and then the function HttpServletResponse.sendError(int, String) is called with the HTTP status code is UWSException.INTERNAL_SERVER_ERROR and the message of the given exception.
    
    Parameters:
    
    error - The error to send/display.
    
    request - The request which has caused the given error (not used by default).
    
    reqID - ID of the request.
    
    user - The user which executes the given request.
    
    uwsAction - The UWS action corresponding to the given request.
    
    response - The response in which the error must be published.
    
    Throws:
    
    java.io.IOException - If there is an error when calling HttpServletResponse.sendError(int, String).
    
    UWSException
    
    javax.servlet.ServletException
    
    See Also:
    
    ServiceErrorWriter.writeError(Throwable, HttpServletResponse, HttpServletRequest, String, JobOwner, String)
  - getLogger
```
public UWSLog getLogger()
```
    Description copied from interface: UWS
    
    Gets the logger of this UWS.
    
    note:A UWS logger is used to watch the HTTP requests received by the UWS and their responses. The activity of the UWS is also logged and particularly the life of the different jobs and their threads. A default implementation is available: DefaultUWSLog.
    
    Specified by:
    
    getLogger in interface UWS
    
    Returns:
    
    Its logger (MUST BE NOT NULL).
  - getErrorWriter
```
public final ServiceErrorWriter getErrorWriter()
```
    Gets the object used to write/format any error in a HttpServletResponse.
    
    Returns:
    
    The error writer/formatter.
  - setErrorWriter
```
public final void setErrorWriter(ServiceErrorWriter errorWriter)
```
    Sets the object used to write/format any error in a HttpServletResponse.
    
    Note: Nothing is done if the given writer is NULL !
    
    Parameters:
    
    errorWriter - The new error writer/formatter.
  - addExpectedAdditionalParameter
```
public final void addExpectedAdditionalParameter(java.lang.String paramName)
```
    Adds the name of an additional parameter which must be identified without taking into account its case and then stored with the case of the given name.
    
    Parameters:
    
    paramName - Name of an additional parameter.
  - getNbExpectedAdditionalParameters
```
public final int getNbExpectedAdditionalParameters()
```
    Gets the number of additional parameters which must be identified with no case sensitivity.
    
    Returns:
    
    Number of expected additional parameters.
  - getExpectedAdditionalParameters
```
public final java.util.List<java.lang.String> getExpectedAdditionalParameters()
```
    Gets the names of the expected additional parameters. These parameters are identified with no case sensitivity and stored in the given case.
    
    Returns:
    
    Names of the expected additional parameters.
  - expectedAdditionalParametersIterator
```
public final java.util.Iterator<java.lang.String> expectedAdditionalParametersIterator()
```
    Gets an iterator on the names of the expected additional parameters.
    
    Returns:
    
    An iterator on the names of the expected additional parameters.
  - removeExpectedAdditionalParam
```
public final void removeExpectedAdditionalParam(java.lang.String paramName)
```
    Removes the name of an expected additional parameter. This parameter will never be identify specifically and so, it will be stored in the same case as in the initial Map or HttpServletRequest.
    
    Parameters:
    
    paramName - Name of an additional parameter.
  - getInputParamControllers
```
public final java.util.Map<java.lang.String,InputParamController> getInputParamControllers()
```
    Gets the list of all UWS input parameter controllers.
    
    Returns:
    
    All parameter controllers.
  - getInputParamControllersIterator
```
public final java.util.Iterator<java.util.Map.Entry<java.lang.String,InputParamController>> getInputParamControllersIterator()
```
    Gets an iterator on the list of all UWS input parameter controllers.
    
    Returns:
    
    An iterator on all parameter controllers.
  - getInputParamController
```
public final InputParamController getInputParamController(java.lang.String inputParamName)
```
    Gets the controller of the specified UWS input parameter.
    
    Parameters:
    
    inputParamName - Name of the parameter whose the controller must be returned.
    
    Returns:
    
    The corresponding controller or null if there is none.
  - setInputParamController
```
public final InputParamController setInputParamController(java.lang.String paramName,
                                                          InputParamController controller)
```
    Sets the controller of the specified input UWS job parameter.
    
    Parameters:
    
    paramName - Name of the parameter with which the given controller will be associated.
    
    controller - An input parameter controller.
    
    Returns:
    
    The former controller associated with the specified parameter or null if there is no controller before this call or if the given parameter name is null or an empty string.
  - removeInputParamController
```
public final InputParamController removeInputParamController(java.lang.String paramName)
```
    Removes the controller of the specified input UWS job parameter.
    
    Parameters:
    
    paramName - Name of the parameter whose the controller must be removed.
    
    Returns:
    
    The removed controller or null if there were no controller or if the given name is null or an empty string.
  - configureExecution
```
public final void configureExecution(long defaultDuration,
                                     long maxDuration,
                                     boolean allowModif)
```
    Lets configuring the execution duration default and maximum value.
    
    note: A new controller is created if needed. Otherwise the current one (if it is an instance of DestructionTimeController) is updated.
    
    Parameters:
    
    defaultDuration - Default duration between the start and the end of the execution of a job.
    
    maxDuration - Maximum duration between the start and the end of the execution of a job that a user can set when creating/initializing a job.
    
    allowModif - true to allow the modification of this parameter after its initialization, false otherwise.
    
    See Also:
    
    ExecutionDurationController
  - configureDestruction
```
public final void configureDestruction(int defaultTime,
                                       DestructionTimeController.DateField defaultTimeUnit,
                                       int maxTime,
                                       DestructionTimeController.DateField maxTimeUnit,
                                       boolean allowModif)
```
    Lets configuring the destruction time default and maximum value.
    
    note: A new controller is created if needed. Otherwise the current one (if it is an instance of ExecutionDurationController) is updated.
    
    Parameters:
    
    defaultTime - Default time since the job creation and its destruction.
    
    defaultTimeUnit - Unit of the default time (i.e. minutes, days, ...).
    
    maxTime - Maximum time since the job creation and its destruction that a user can set when creating/initializing a job.
    
    maxTimeUnit - Unit of the maximum time (i.e. minutes, days, ...).
    
    allowModif - true to allow the modification of this parameter after its initialization, false otherwise.
    
    See Also:
    
    DestructionTimeController
  - getName
```
public final java.lang.String getName()
```
    Description copied from interface: UWS
    
    Gets the name of this UWS.
    
    Specified by:
    
    getName in interface UWS
    
    Returns:
    
    The name.
  - getDescription
```
public final java.lang.String getDescription()
```
    Description copied from interface: UWS
    
    Gets the description of this UWS.
    
    Specified by:
    
    getDescription in interface UWS
    
    Returns:
    
    The description.
  - iterator
```
public final java.util.Iterator<JobList> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<JobList>
  - getJobList
```
public JobList getJobList(java.lang.String name)
                   throws UWSException
```
    Description copied from interface: UWS
    
    Gets the jobs list whose the name matches exactly the given one.
    
    Specified by:
    
    getJobList in interface UWS
    
    Parameters:
    
    name - Name of the jobs list to get.
    
    Returns:
    
    The corresponding jobs list.
    
    Throws:
    
    UWSException - If the given name is null or empty, or if no jobs list matches.
  - getNbJobList
```
public final int getNbJobList()
```
    Description copied from interface: UWS
    
    Gets the number of managed jobs lists.
    
    Specified by:
    
    getNbJobList in interface UWS
    
    Returns:
    
    The number of jobs lists.
  - addJobList
```
public final boolean addJobList(JobList jl)
```
    Description copied from interface: UWS
    
    Adds a jobs list to this UWS.
    
    Specified by:
    
    addJobList in interface UWS
    
    Parameters:
    
    jl - The jobs list to add.
    
    Returns:
    
    true if the jobs list has been successfully added, false if the given jobs list is null or if a jobs list with this name already exists or if a UWS is already associated with another UWS.
  - destroyJobList
```
public final boolean destroyJobList(java.lang.String name)
```
    Description copied from interface: UWS
    
    Destroys the specified jobs list.
    
    note: After the call of this function, the UWS reference of the given jobs list should be removed (see JobList.setUWS(UWS)).
    
    Specified by:
    
    destroyJobList in interface UWS
    
    Parameters:
    
    name - Name of the jobs list to destroy.
    
    Returns:
    
    true if the given jobs list has been destroyed, false otherwise.
  - destroyJobList
```
public boolean destroyJobList(JobList jl)
```
    Destroys the given jobs list.
    
    Parameters:
    
    jl - The jobs list to destroy.
    
    Returns:
    
    true if the given jobs list has been destroyed, false otherwise.
    
    See Also:
    
    JobList.clear(), JobList.setUWS(UWS)
  - addSerializer
```
public final boolean addSerializer(UWSSerializer serializer)
```
    Adds a serializer to this UWS
    
    WARNING: If there is already a serializer with the same MIME type (see UWSSerializer.getMimeType()) in this UWS , it should be replaced by the given one !
    
    Parameters:
    
    serializer - The serializer to add.
    
    Returns:
    
    true if the serializer has been successfully added, false otherwise.
  - getSerializer
```
public final UWSSerializer getSerializer(java.lang.String mimeTypes)
                                  throws UWSException
```
    Gets the serializer whose the MIME type is the same as the given one.
    
    Note: If this UWS has no corresponding serializer, its default one will be returned !
    
    Specified by:
    
    getSerializer in interface UWS
    
    Parameters:
    
    mimeTypes - The MIME type of the searched serializer (may be more than one MIME types - comma separated ; see the format of the Accept header of a HTTP-Request).
    
    Returns:
    
    The corresponding serializer or the default serializer of this UWS if no corresponding serializer has been found.
    
    Throws:
    
    UWSException - If there is no corresponding serializer AND if the default serializer of this UWS can not be found.
    
    See Also:
    
    AcceptHeader.AcceptHeader(String), AcceptHeader.getOrderedMimeTypes()
  - removeSerializer
```
public final UWSSerializer removeSerializer(java.lang.String mimeType)
```
    Removes the serializer whose the MIME type is the same as the given one.
    
    Parameters:
    
    mimeType - MIME type of the serializer to remove.
    
    Returns:
    
    The removed serializer or null if no corresponding serializer has been found.
  - getXsltURL
```
public final java.lang.String getXsltURL()
```
    Gets the URL of the XSLT style-sheet that the XML serializer of this UWS is using.
    
    Returns:
    
    The used XSLT URL.
  - setXsltURL
```
public final boolean setXsltURL(java.lang.String xsltPath)
```
    Sets the URL of the XSLT style-sheet that the XML serializer of this UWS must use.
    
    Parameters:
    
    xsltPath - The new XSLT URL.
    
    Returns:
    
    true if the given path/url has been successfully set, false otherwise.
  - getUserIdentifier
```
public final UserIdentifier getUserIdentifier()
```
    Gets the object which lets extracting the user ID from a HTTP request.
    
    note:If the returned user identifier is NULL, no job should have an owner.
    
    Specified by:
    
    getUserIdentifier in interface UWS
    
    Returns:
    
    The used UserIdentifier (MAY BE NULL).
  - setUserIdentifier
```
public final void setUserIdentifier(UserIdentifier identifier)
```
    Sets the object which lets extracting the use ID from a received request.
    
    Parameters:
    
    identifier - The UserIdentifier to use (may be null).
  - getUrlInterpreter
```
public final UWSUrl getUrlInterpreter()
```
    Gets the UWS URL interpreter of this UWS.
    
    Specified by:
    
    getUrlInterpreter in interface UWS
    
    Returns:
    
    Its UWS URL interpreter.
  - setUrlInterpreter
```
public final void setUrlInterpreter(UWSUrl urlInterpreter)
```
    Sets the UWS URL interpreter to use in this UWS.
    
    Parameters:
    
    urlInterpreter - Its new UWS URL interpreter (may be null. In this case, it will be created from the next request ; see service(HttpServletRequest, HttpServletResponse)).
  - getBackupManager
```
public final UWSBackupManager getBackupManager()
```
    Gets its backup manager.
    
    Specified by:
    
    getBackupManager in interface UWS
    
    Returns:
    
    Its backup manager.

Class UWSServlet

UWS Definition

UWS customization

Field Summary

Fields inherited from interface uws.service.UWS

Constructor Summary

Method Summary

Methods inherited from class javax.servlet.http.HttpServlet

Methods inherited from class javax.servlet.GenericServlet

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Methods inherited from interface uws.service.UWSFactory

Field Detail

name

description

defaultSerializer

userIdentifier

expectedAdditionalParams

inputParamControllers

backupManager

logger

requestParser

errorWriter

waitPolicy

lastRequestID

Constructor Detail

UWSServlet

Method Detail

init

init

initUWS

destroy

createFileManager

getFileManager

getRequestParser

service

generateRequestID

service

getWaitPolicy

setWaitPolicy

writeHomePage

doListJob

doAddJob

doSetUWSParameter

doDestroyJob

doJobSummary

doGetJobParam

doSetJobParam

getJob

getJob

getFactory

createJob

createJob

createUWSParameters

createUWSParameters

createRequestParser

redirect

sendError

sendError

getLogger

getErrorWriter

setErrorWriter

addExpectedAdditionalParameter

getNbExpectedAdditionalParameters

getExpectedAdditionalParameters

expectedAdditionalParametersIterator

removeExpectedAdditionalParam

getInputParamControllers

getInputParamControllersIterator

getInputParamController

setInputParamController

removeInputParamController

configureExecution

configureDestruction

getName

getDescription

iterator

getJobList

getNbJobList

addJobList