uws.service

Class AbstractUWSFactory

java.lang.Object

uws.service.AbstractUWSFactory

All Implemented Interfaces:

UWSFactory

public abstract class AbstractUWSFactory
extends java.lang.Object
implements UWSFactory

Abstract implementation of UWSFactory. Only the function which creates a JobThread from a UWSJob needs to be implemented.

Version:

4.3 (09/2017)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
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.

Constructor Summary

Constructors

Constructor and Description
AbstractUWSFactory()
AbstractUWSFactory(java.lang.String[] expectedAdditionalParams) Builds a factory with a list of the name of all expected additional parameters.

Method Summary

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.
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.
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.
java.util.Iterator<java.lang.String>	expectedAdditionalParametersIterator() Gets an iterator on the names of the expected additional parameters.
java.util.List<java.lang.String>	getExpectedAdditionalParameters() Gets the names of the expected additional parameters.
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.
int	getNbExpectedAdditionalParameters() Gets the number of additional parameters which must be identified with no case sensitivity.
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.
InputParamController	setInputParamController(java.lang.String paramName, InputParamController controller) Sets the controller of the specified input UWS job parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface uws.service.UWSFactory

createJobThread

Field Detail

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.

expectedAdditionalParams

protected final java.util.ArrayList<java.lang.String> expectedAdditionalParams

List of all expected additional parameters.

Constructor Detail

AbstractUWSFactory

public AbstractUWSFactory()

AbstractUWSFactory

public AbstractUWSFactory(java.lang.String[] expectedAdditionalParams)

Builds a factory with a list of the name of all expected additional parameters. These parameters will be identified by UWSParameters without taking into account their case and they will stored with the case of their name in the given list.

Parameters:

expectedAdditionalParams - Names of the expected parameters.

Method Detail

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.

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