uws.config

Class ConfigurableUWSFactory

java.lang.Object

uws.config.ConfigurableUWSFactory

All Implemented Interfaces:

UWSFactory

public class ConfigurableUWSFactory
extends java.lang.Object
implements UWSFactory

Concrete implementation of a UWSFactory which is parameterized by a UWS configuration file.

Since:

4.2

Version:

4.3 (09/2017)

Author:

Grégory Mantelet (ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.reflect.Constructor<? extends RequestParser>	constructorRequestParser Constructor of the RequestParser to create for the whole UWS service.
protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,InputParamController>>	jobParams List of parameters (and eventually how to control them) for each job-list/job.
protected java.util.Map<java.lang.String,java.lang.reflect.Constructor<? extends JobThread>>	jobThreads Map associating the name of a job list with the constructor of the class of the jobs to create inside this job list.
protected static java.util.regex.Pattern	PATTERN_PARAMETER Regular Expression of a job parameters list.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableUWSFactory() Create an empty factory.
	ConfigurableUWSFactory(java.util.Properties uwsConfig) Create and initialize a UWS factory thanks to properties coming from a UWS configuration file.

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 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.
protected void	initParameters(java.lang.String jlName, java.lang.String propValue) Parse the given list of parameters + their limits/controller and update the list of parameters for the specified job list.

Methods inherited from class java.lang.Object

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

Field Detail

constructorRequestParser

protected java.lang.reflect.Constructor<? extends RequestParser> constructorRequestParser

Constructor of the RequestParser to create for the whole UWS service.

If null, the default UWS request parser (i.e. UWSRequestParser) will be used.

jobThreads

protected java.util.Map<java.lang.String,java.lang.reflect.Constructor<? extends JobThread>> jobThreads

Map associating the name of a job list with the constructor of the class of the jobs to create inside this job list.

jobParams

protected java.util.Map<java.lang.String,java.util.Map<java.lang.String,InputParamController>> jobParams

List of parameters (and eventually how to control them) for each job-list/job.

PATTERN_PARAMETER

protected static final java.util.regex.Pattern PATTERN_PARAMETER

Regular Expression of a job parameters list.

The following parameter types are supported:

• Just a parameter name (i.e. no controller):

  \s*([^,\[\]]*)\s*(,(.*))?

  Example: param1

  • group(16) = parameter name
  • group(18) = all other parameters (without the leading comma)
• A parameter name and the class of an InputParamController:

  \s*\[([^,]+),(\{[^\}]*\})\s*\]\s*(,(.*))?

  Example: [param1, {aPackage.MyCustomController}]

  • group(2) = parameter name
  • group(4) = controller class name
• A parameter name and description of a string controller:

  \s*\[([^,]+),([^,]*),\s*(string)\s*,\s*"([^,]*)"\s*,\s* /(([^\/]|//)*)/(i)?\s*\]\s*(,(.*))?

  Example: [param1, true, string, "default", /mySuperRegexp/i]

  • group(2) = parameter name
  • group(5) = a boolean expression (yes, y, true, t) to indicate whether the parameter can be modified by the user
  • group(11) = string
  • group(12) = default value (it must be provided between brackets as in the example above)
  • group(13) = the regular expression
  • group(15) = i if the regular expression must be evaluated in a case insensitive manner
• A parameter name and description of a numeric controller:

  \s*\[([^,]+),([^,]*),\s*(numeric)\s*,([^,]*),([^,]*),([^,]*)\s*\]\s*(,(.*))?

  Example: [param1, true, numeric, 10, 0, 20]

  • group(2) = parameter name
  • group(5) = a boolean expression (yes, y, true, t) to indicate whether the parameter can be modified by the user
  • group(7) = numeric
  • group(8) = default value ; only a numeric value (floating number or not ; negative or not) will be allowed after the expression has been parsed
  • group(9) = minimum value ; only a numeric value (floating number or not ; negative or not) will be allowed after the expression has been parsed
  • group(10) = maximum value ; only a numeric value (floating number or not ; negative or not) will be allowed after the expression has been parsed
• A parameter name and description of a duration controller:

  \s*\[([^,]+),([^,]*),\s*(duration)\s*,([^,]*),([^,]*),([^,]*)\s*\]\s*(,(.*))?

  Example: [param1, true, numeric, 10, 0, 20]

  • group(2) = parameter name
  • group(5) = a boolean expression (yes, y, true, t) to indicate whether the parameter can be modified by the user
  • group(7) = numeric
  • group(8) = default value
  • group(9) = minimum value
  • group(10) = maximum value

  The default, minimum and maximum value must a positive integer value followed eventually by a unit. If no unit is specified, the default is milliseconds. See below for all supported units:

  • milliseconds, ms
  • seconds, sec, s
  • minutes, min, m
  • hours, h
  • days, D
  • weeks, W
  • months, M
  • years, Y

Constructor Detail

ConfigurableUWSFactory

protected ConfigurableUWSFactory()

Create an empty factory.

Using this constructor, no JobThread can be created. You have to add some in jobThreads for each job list you have to support. The parameters of each job/job-list can be listed in jobParams.

ConfigurableUWSFactory

public ConfigurableUWSFactory(java.util.Properties uwsConfig)
                       throws UWSException

Create and initialize a UWS factory thanks to properties coming from a UWS configuration file.

The following properties are supported by this constructor:

• KEY_REQUEST_PARSER
• KEY_REGEXP_JOB_THREAD
• KEY_REGEXP_PARAMETERS
• KEY_REGEXP_DEFAULT_EXEC_DURATION
• KEY_REGEXP_MAX_EXEC_DURATION
• KEY_REGEXP_DEFAULT_DESTRUCTION_INTERVAL
• KEY_REGEXP_MAX_DESTRUCTION_INTERVAL

Parameters:

uwsConfig - Configuration of this factory.

Throws:

UWSException - If the initialization fails.

Method Detail

initParameters

protected void initParameters(java.lang.String jlName,
                              java.lang.String propValue)
                       throws UWSException

Parse the given list of parameters + their limits/controller and update the list of parameters for the specified job list.

The given string is parsed using PATTERN_PARAMETER. The expected syntax of one item of this list is explained in the javadoc of PATTERN_PARAMETER.

If just a parameter name is given, it is anyway added to the map of parameters of the specified job list, but with a null InputParamController. The idea is to indicate the parameter is expected with this name, but there is no specific restriction on its value.

Parameters:

jlName - Name of the job list for which the given list of parameters is expected.

propValue - String expressing the list of expected parameters (and eventually their limits/controller).

Throws:

UWSException - If the syntax of a parameter description is incorrect.

createJobThread

public JobThread createJobThread(UWSJob jobDescription)
                          throws UWSException

Description copied from interface: UWSFactory

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

Specified by:

createJobThread in interface UWSFactory

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.

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.