UWSConfiguration

java.lang.Object
- uws.config.UWSConfiguration

```
public final class UWSConfiguration
extends java.lang.Object
```
Utility class gathering tool functions and properties' names useful to deal with a UWS configuration file.

This class implements the Design Pattern "Utility": no instance of this class can be created, it can not be extended, and it must be used only thanks to its static classes and attributes.

Since:

4.3

Version:

4.3 (07/2018)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_BACKUP_BY_USER` Default value of the property `KEY_BACKUP_BY_USER`: false.
`static long`	`DEFAULT_BACKUP_FREQUENCY` Default value of the property `KEY_BACKUP_FREQUENCY`: `DEFAULT_BACKUP_FREQUENCY`.
`static boolean`	`DEFAULT_DIRECTORY_PER_USER` Default value of the property `KEY_DIRECTORY_PER_USER`: false.
`static int`	`DEFAULT_EXECUTION_DURATION` Default value of the property `KEY_DEFAULT_EXECUTION_DURATION` and `KEY_MAX_EXECUTION_DURATION`: 0.
`static java.lang.String`	`DEFAULT_FILE_MANAGER` Default value of the property `KEY_FILE_MANAGER`: "local".
`static boolean`	`DEFAULT_GROUP_USER_DIRECTORIES` Default value of the property `KEY_GROUP_USER_DIRECTORIES`: false.
`static java.lang.String`	`DEFAULT_LOGGER` Default value of the property `KEY_LOGGER`: "default".
`static java.lang.String`	`DEFAULT_UWS_CONF_FILE` Default UWS configuration file.
`static java.lang.String`	`KEY_ADD_SERIALIZERS` Name/Key of the property specifying a list of UWS serializers to add to the UWS service.
`static java.lang.String`	`KEY_ADD_UWS_ACTIONS` Name/Key of the property specifying a list of actions to add to the UWS service.
`static java.lang.String`	`KEY_BACKUP_BY_USER` Name/Key of the property indicating whether there should be one backup file per user or one file for all.
`static java.lang.String`	`KEY_BACKUP_FREQUENCY` Name/Key of the property specifying the frequency (in milliseconds) of jobs backup.
`static java.lang.String`	`KEY_DEFAULT_DESTRUCTION_INTERVAL` Name/Key of the property specifying the default destruction interval (actually a duration between the creation and the destruction of the job) set automatically to a job if none has been specified by the user.
`static java.lang.String`	`KEY_DEFAULT_EXECUTION_DURATION` Name/Key of the property specifying the default execution duration (in milliseconds) set automatically to a job if none has been specified by the user.
`static java.lang.String`	`KEY_DESTRUCTION_MANAGER` Name/Key of the property specifying the `DestructionManager` instance that a specific job list must use.
`static java.lang.String`	`KEY_DIRECTORY_PER_USER` Name/Key of the property indicating whether the jobs must be saved by user or not.
`static java.lang.String`	`KEY_ERROR_WRITER` Name/Key of the property specifying the error writer the UWS service must use.
`static java.lang.String`	`KEY_EXECUTION_MANAGER` Name/Key of the property specifying the `ExecutionManager` instance that a specific job list must use.
`static java.lang.String`	`KEY_FILE_MANAGER` Name/Key of the property setting the file manager to use in the UWS service.
`static java.lang.String`	`KEY_FILE_ROOT_PATH` Name/Key of the property setting the local root directory where all UWS files must be stored.
`static java.lang.String`	`KEY_GROUP_USER_DIRECTORIES` Name/Key of the property indicating whether the user directories (in which jobs of the user are backuped) must be gathered in less directories.
`static java.lang.String`	`KEY_HOME_PAGE` Name/Key of the property specifying the UWS home page to use.
`static java.lang.String`	`KEY_HOME_PAGE_MIME_TYPE` Name/Key of the property specifying the MIME type of the set home page.
`static java.lang.String`	`KEY_JOB_LISTS` Name/Key of the property listing all the job lists to have in the UWS service.
`static java.lang.String`	`KEY_JOB_THREAD` Name/Key of the property specifying the `JobThread` instance to use for a specific job list.
`static java.lang.String`	`KEY_LOG_ROTATION` Name/Key of the property specifying the frequency of the log file rotation to set in the default logger.
`static java.lang.String`	`KEY_LOGGER` Name/Key of the property specifying the logger to use.
`static java.lang.String`	`KEY_MAX_DESTRUCTION_INTERVAL` Name/Key of the property specifying the maximum destruction interval (actually a duration between the creation and the destruction of the job) set automatically to a job if none has been specified by the user.
`static java.lang.String`	`KEY_MAX_EXECUTION_DURATION` Name/Key of the property specifying the maximum execution duration (in milliseconds) that can be set on a job.
`static java.lang.String`	`KEY_MAX_RUNNING_JOBS` Name/Key of the property specifying the maximum number of jobs that can run in parallel inside a specific job list.
`static java.lang.String`	`KEY_MIN_LOG_LEVEL` Name/Key of the property specifying the minimum type of messages (i.e.
`static java.lang.String`	`KEY_PARAMETERS` Name/Key of the property listing all input parameters of jobs of a specific job list.
`static java.lang.String`	`KEY_REGEXP_MAX_DESTRUCTION_INTERVAL` Regular Expression of the name/key of the property specifying the maximum destruction interval for jobs of a given job list.
`static java.lang.String`	`KEY_REQUEST_PARSER` Name/Key of the property specifying the `RequestParser` class to use instead of the default `UWSRequestParser`.
`static java.lang.String`	`KEY_SERVICE_DESCRIPTION` Name/Key of the property specifying the description of the UWS service.
`static java.lang.String`	`KEY_SERVICE_NAME` Name/Key of the property specifying the name of this UWS service.
`static java.lang.String`	`KEY_USER_IDENTIFIER` Name/Key of the property specifying the user identification method to use.
`static java.lang.String`	`KEY_UWS_FACTORY` Name/Key of the property specifying the `UWSFactory` class to use instead of the default `ConfigurableUWSFactory`.
`static java.lang.String`	`KEY_XSLT_STYLESHEET` Name/Key of the property specifying the XSLT stylesheet to use when job are serialized in XML.
`static java.lang.String`	`REGEXP_DEFAULT_DESTRUCTION_INTERVAL` Regular Expression of the name/key of the property specifying the default destruction interval for jobs of a given job list.
`static java.lang.String`	`REGEXP_DEFAULT_EXEC_DURATION` Regular Expression of the name/key of the property specifying the default execution duration for jobs of a given job list.
`static java.lang.String`	`REGEXP_DESTRUCTION_MANAGER` Regular Expression of the name/key of the property specifying the `DestructionManager` instance that a given job list must use.
`static java.lang.String`	`REGEXP_EXECUTION_MANAGER` Regular Expression of the name/key of the property specifying the `ExecutionManager` instance that a given job list must use.
`static java.lang.String`	`REGEXP_JOB_LIST_NAME` Regular Expression of a job list name supposed to represent a job list name.
`static java.lang.String`	`REGEXP_JOB_THREAD` Regular Expression of the name/key of the property specifying the `JobThread` instance to use for a given job list.
`static java.lang.String`	`REGEXP_MAX_EXEC_DURATION` Regular Expression of the name/key of the property specifying the maximum execution duration for jobs of a given job list.
`static java.lang.String`	`REGEXP_MAX_RUNNING_JOBS` Regular Expression of the name/key of the property specifying maximum number of jobs that can run in parallel inside the specified job list.
`static java.lang.String`	`REGEXP_PARAMETERS` Regular Expression of the name/key of the property listing all parameters expected for jobs of a given job list.
`static java.lang.String`	`SLF4J_LOGGER` SLF4J logger value: "slf4j".
`static java.lang.String`	`UWS_CONF_PARAMETER` Name of the initial parameter to set in the WEB-INF/web.xml file in order to specify the location and the name of the UWS configuration file to load.
`static java.lang.String`	`VALUE_LOCAL` Value of the property `KEY_FILE_MANAGER` specifying a local file manager.
`static java.lang.String`	`VALUE_NEVER` Value of the property `KEY_BACKUP_FREQUENCY` indicating that jobs should never be backuped.
`static java.lang.String`	`VALUE_USER_ACTION` Value of the property `KEY_BACKUP_FREQUENCY` indicating that job backup should occur only when the user creates or modifies one of his jobs.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`extractJobListName(java.lang.String compoundPropertyName)` Extract the job list name prefixing the given property name.
`static <C> java.lang.Class<? extends C>`	`fetchClass(java.lang.String value, java.lang.String propertyName, java.lang.Class<C> expectedType)` Fetch the class object corresponding to the class name provided between brackets in the given value.
`static <C> java.lang.reflect.Constructor<? extends C>`	`fetchConstructor(java.lang.String propValue, java.lang.String propName, java.lang.Class<C> expectedType, java.lang.Class<?>[] pTypes)` Fetch the specified constructor of the class corresponding to the class name provided between brackets in the given value.
`static java.lang.String`	`getProperty(java.util.Properties prop, java.lang.String key)` Read the asked property from the given Properties object.
`static <C> boolean`	`hasConstructor(java.lang.String propValue, java.lang.String propName, java.lang.Class<C> expectedType, java.lang.Class<?>[] pTypes)` Test whether the specified class has a constructor with the specified parameters.
`static boolean`	`isClassName(java.lang.String value)` Test whether a property value is a class name.
`static <C> C`	`newInstance(java.lang.String propValue, java.lang.String propName, java.lang.Class<C> expectedType)` Create an instance of the specified class.
`static <C> C`	`newInstance(java.lang.String propValue, java.lang.String propName, java.lang.Class<C> expectedType, java.lang.Class<?>[] pTypes, java.lang.Object[] parameters)` Create an instance of the specified class.
`static long`	`parseLimit(java.lang.String value, java.lang.String propertyName)` Lets parsing a limit (for upload, ...) with its numeric value and its unit.

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

- Field Detail
  - UWS_CONF_PARAMETER
```
public static final java.lang.String UWS_CONF_PARAMETER
```
    Name of the initial parameter to set in the WEB-INF/web.xml file in order to specify the location and the name of the UWS configuration file to load.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_UWS_CONF_FILE
```
public static final java.lang.String DEFAULT_UWS_CONF_FILE
```
    Default UWS configuration file. This file is research automatically if none is specified in the WEB-INF/web.xml initial parameter "uwsconf".
    
    See Also:
    
    Constant Field Values
  - KEY_HOME_PAGE
```
public static final java.lang.String KEY_HOME_PAGE
```
    Name/Key of the property specifying the UWS home page to use. It can be a file, a URL or a class. If null, the default UWS home page of the library is used. By default the default library home page is used.
    
    See Also:
    
    Constant Field Values
  - KEY_HOME_PAGE_MIME_TYPE
```
public static final java.lang.String KEY_HOME_PAGE_MIME_TYPE
```
    Name/Key of the property specifying the MIME type of the set home page. By default, "text/html" is set.
    
    See Also:
    
    Constant Field Values
  - KEY_SERVICE_NAME
```
public static final java.lang.String KEY_SERVICE_NAME
```
    Name/Key of the property specifying the name of this UWS service.
    
    See Also:
    
    Constant Field Values
  - KEY_SERVICE_DESCRIPTION
```
public static final java.lang.String KEY_SERVICE_DESCRIPTION
```
    Name/Key of the property specifying the description of the UWS service.
    
    See Also:
    
    Constant Field Values
  - KEY_JOB_LISTS
```
public static final java.lang.String KEY_JOB_LISTS
```
    Name/Key of the property listing all the job lists to have in the UWS service.
    
    See Also:
    
    Constant Field Values
  - REGEXP_JOB_LIST_NAME
```
public static final java.lang.String REGEXP_JOB_LIST_NAME
```
    Regular Expression of a job list name supposed to represent a job list name. This name MUST contain NO point, NO equal sign (=) and NO space character.
    
    See Also:
    
    Constant Field Values
  - KEY_JOB_THREAD
```
public static final java.lang.String KEY_JOB_THREAD
```
    Name/Key of the property specifying the JobThread instance to use for a specific job list.
    
    See Also:
    
    Constant Field Values
  - REGEXP_JOB_THREAD
```
public static final java.lang.String REGEXP_JOB_THREAD
```
    Regular Expression of the name/key of the property specifying the JobThread instance to use for a given job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_JOB_THREAD ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_PARAMETERS
```
public static final java.lang.String KEY_PARAMETERS
```
    Name/Key of the property listing all input parameters of jobs of a specific job list.
    
    See Also:
    
    Constant Field Values
  - REGEXP_PARAMETERS
```
public static final java.lang.String REGEXP_PARAMETERS
```
    Regular Expression of the name/key of the property listing all parameters expected for jobs of a given job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_PARAMETERS ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_DEFAULT_EXECUTION_DURATION
```
public static final java.lang.String KEY_DEFAULT_EXECUTION_DURATION
```
    Name/Key of the property specifying the default execution duration (in milliseconds) set automatically to a job if none has been specified by the user.
    
    See Also:
    
    Constant Field Values
  - REGEXP_DEFAULT_EXEC_DURATION
```
public static final java.lang.String REGEXP_DEFAULT_EXEC_DURATION
```
    Regular Expression of the name/key of the property specifying the default execution duration for jobs of a given job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_DEFAULT_EXECUTION_DURATION ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_MAX_EXECUTION_DURATION
```
public static final java.lang.String KEY_MAX_EXECUTION_DURATION
```
    Name/Key of the property specifying the maximum execution duration (in milliseconds) that can be set on a job.
    
    See Also:
    
    Constant Field Values
  - REGEXP_MAX_EXEC_DURATION
```
public static final java.lang.String REGEXP_MAX_EXEC_DURATION
```
    Regular Expression of the name/key of the property specifying the maximum execution duration for jobs of a given job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_MAX_EXECUTION_DURATION ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_EXECUTION_DURATION
```
public static final int DEFAULT_EXECUTION_DURATION
```
    Default value of the property KEY_DEFAULT_EXECUTION_DURATION and KEY_MAX_EXECUTION_DURATION: 0.
    
    See Also:
    
    Constant Field Values
  - KEY_MAX_RUNNING_JOBS
```
public static final java.lang.String KEY_MAX_RUNNING_JOBS
```
    Name/Key of the property specifying the maximum number of jobs that can run in parallel inside a specific job list.
    
    See Also:
    
    Constant Field Values
  - REGEXP_MAX_RUNNING_JOBS
```
public static final java.lang.String REGEXP_MAX_RUNNING_JOBS
```
    Regular Expression of the name/key of the property specifying maximum number of jobs that can run in parallel inside the specified job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_MAX_RUNNING_JOBS ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_EXECUTION_MANAGER
```
public static final java.lang.String KEY_EXECUTION_MANAGER
```
    Name/Key of the property specifying the ExecutionManager instance that a specific job list must use.
    
    See Also:
    
    Constant Field Values
  - REGEXP_EXECUTION_MANAGER
```
public static final java.lang.String REGEXP_EXECUTION_MANAGER
```
    Regular Expression of the name/key of the property specifying the ExecutionManager instance that a given job list must use.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_EXECUTION_MANAGER ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_DEFAULT_DESTRUCTION_INTERVAL
```
public static final java.lang.String KEY_DEFAULT_DESTRUCTION_INTERVAL
```
    Name/Key of the property specifying the default destruction interval (actually a duration between the creation and the destruction of the job) set automatically to a job if none has been specified by the user.
    
    See Also:
    
    Constant Field Values
  - REGEXP_DEFAULT_DESTRUCTION_INTERVAL
```
public static final java.lang.String REGEXP_DEFAULT_DESTRUCTION_INTERVAL
```
    Regular Expression of the name/key of the property specifying the default destruction interval for jobs of a given job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_DEFAULT_DESTRUCTION_INTERVAL ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_MAX_DESTRUCTION_INTERVAL
```
public static final java.lang.String KEY_MAX_DESTRUCTION_INTERVAL
```
    Name/Key of the property specifying the maximum destruction interval (actually a duration between the creation and the destruction of the job) set automatically to a job if none has been specified by the user.
    
    See Also:
    
    Constant Field Values
  - KEY_REGEXP_MAX_DESTRUCTION_INTERVAL
```
public static final java.lang.String KEY_REGEXP_MAX_DESTRUCTION_INTERVAL
```
    Regular Expression of the name/key of the property specifying the maximum destruction interval for jobs of a given job list.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name.
    
    See Also:
    
    Constant Field Values
  - KEY_DESTRUCTION_MANAGER
```
public static final java.lang.String KEY_DESTRUCTION_MANAGER
```
    Name/Key of the property specifying the DestructionManager instance that a specific job list must use.
    
    See Also:
    
    Constant Field Values
  - REGEXP_DESTRUCTION_MANAGER
```
public static final java.lang.String REGEXP_DESTRUCTION_MANAGER
```
    Regular Expression of the name/key of the property specifying the DestructionManager instance that a given job list must use.
    The first part of this regular expression (REGEXP_JOB_LIST_NAME) is supposed to be the job list name. Then a point is appended and finally KEY_DESTRUCTION_MANAGER ends the regular expression.
    
    See Also:
    
    Constant Field Values
  - KEY_FILE_MANAGER
```
public static final java.lang.String KEY_FILE_MANAGER
```
    Name/Key of the property setting the file manager to use in the UWS service.
    
    See Also:
    
    Constant Field Values
  - VALUE_LOCAL
```
public static final java.lang.String VALUE_LOCAL
```
    Value of the property KEY_FILE_MANAGER specifying a local file manager.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_FILE_MANAGER
```
public static final java.lang.String DEFAULT_FILE_MANAGER
```
    Default value of the property KEY_FILE_MANAGER: "local".
    
    See Also:
    
    Constant Field Values
  - KEY_FILE_ROOT_PATH
```
public static final java.lang.String KEY_FILE_ROOT_PATH
```
    Name/Key of the property setting the local root directory where all UWS files must be stored. This property is used only if KEY_FILE_MANAGER is set to VALUE_LOCAL.
    
    See Also:
    
    Constant Field Values
  - KEY_DIRECTORY_PER_USER
```
public static final java.lang.String KEY_DIRECTORY_PER_USER
```
    Name/Key of the property indicating whether the jobs must be saved by user or not. If yes, there will be one directory per user. Otherwise, all jobs are backuped in the same directory (generally KEY_FILE_ROOT_PATH).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DIRECTORY_PER_USER
```
public static final boolean DEFAULT_DIRECTORY_PER_USER
```
    Default value of the property KEY_DIRECTORY_PER_USER: false.
    
    See Also:
    
    Constant Field Values
  - KEY_GROUP_USER_DIRECTORIES
```
public static final java.lang.String KEY_GROUP_USER_DIRECTORIES
```
    Name/Key of the property indicating whether the user directories (in which jobs of the user are backuped) must be gathered in less directories. If yes, the groups are generally made using the alphabetic order. The idea is to reduce the number of apparent directories and to easier the research of a user directory.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GROUP_USER_DIRECTORIES
```
public static final boolean DEFAULT_GROUP_USER_DIRECTORIES
```
    Default value of the property KEY_GROUP_USER_DIRECTORIES: false.
    
    See Also:
    
    Constant Field Values
  - KEY_LOGGER
```
public static final java.lang.String KEY_LOGGER
```
    Name/Key of the property specifying the logger to use. By default, DefaultUWSLog is used.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LOGGER
```
public static final java.lang.String DEFAULT_LOGGER
```
    Default value of the property KEY_LOGGER: "default".
    
    See Also:
    
    Constant Field Values
  - KEY_MIN_LOG_LEVEL
```
public static final java.lang.String KEY_MIN_LOG_LEVEL
```
    Name/Key of the property specifying the minimum type of messages (i.e. DEBUG, INFO, WARNING, ERROR, FATAL) that must be logged by the default logger.
    By default all messages are logged...which is equivalent to set this property to "DEBUG".
    
    Note: If KEY_LOGGER is set to a value different from "default", this property is ignored.
    
    See Also:
    
    Constant Field Values
  - KEY_LOG_ROTATION
```
public static final java.lang.String KEY_LOG_ROTATION
```
    Name/Key of the property specifying the frequency of the log file rotation to set in the default logger.
    By default the log rotation occurs every day at midnight.
    
    Note: If KEY_LOGGER is set to a value different from "default", this property is ignored.
    
    See Also:
    
    Constant Field Values
  - SLF4J_LOGGER
```
public static final java.lang.String SLF4J_LOGGER
```
    SLF4J logger value: "slf4j".
    
    Since:
    
    4.3
    
    See Also:
    
    Constant Field Values
  - KEY_BACKUP_FREQUENCY
```
public static final java.lang.String KEY_BACKUP_FREQUENCY
```
    Name/Key of the property specifying the frequency (in milliseconds) of jobs backup. This property accepts three types of value: "never" (default), "user_action" (the backup of a job is done when it is modified), or a numeric positive value (expressed in milliseconds).
    
    See Also:
    
    Constant Field Values
  - VALUE_NEVER
```
public static final java.lang.String VALUE_NEVER
```
    Value of the property KEY_BACKUP_FREQUENCY indicating that jobs should never be backuped.
    
    See Also:
    
    Constant Field Values
  - VALUE_USER_ACTION
```
public static final java.lang.String VALUE_USER_ACTION
```
    Value of the property KEY_BACKUP_FREQUENCY indicating that job backup should occur only when the user creates or modifies one of his jobs. This value can be used ONLY IF KEY_BACKUP_BY_USER is "true".
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKUP_FREQUENCY
```
public static final long DEFAULT_BACKUP_FREQUENCY
```
    Default value of the property KEY_BACKUP_FREQUENCY: DEFAULT_BACKUP_FREQUENCY.
    
    See Also:
    
    Constant Field Values
  - KEY_BACKUP_BY_USER
```
public static final java.lang.String KEY_BACKUP_BY_USER
```
    Name/Key of the property indicating whether there should be one backup file per user or one file for all.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BACKUP_BY_USER
```
public static final boolean DEFAULT_BACKUP_BY_USER
```
    Default value of the property KEY_BACKUP_BY_USER: false. This property can be enabled only if a user identification method is provided.
    
    See Also:
    
    Constant Field Values
  - KEY_USER_IDENTIFIER
```
public static final java.lang.String KEY_USER_IDENTIFIER
```
    Name/Key of the property specifying the user identification method to use. None is implemented by the library, so a class must be provided as value of this property.
    
    See Also:
    
    Constant Field Values
  - KEY_REQUEST_PARSER
```
public static final java.lang.String KEY_REQUEST_PARSER
```
    Name/Key of the property specifying the RequestParser class to use instead of the default UWSRequestParser.
    
    See Also:
    
    Constant Field Values
  - KEY_ADD_SERIALIZERS
```
public static final java.lang.String KEY_ADD_SERIALIZERS
```
    Name/Key of the property specifying a list of UWS serializers to add to the UWS service. By default, this list if empty ; only the default UWS serializers exist.
    
    See Also:
    
    Constant Field Values
  - KEY_XSLT_STYLESHEET
```
public static final java.lang.String KEY_XSLT_STYLESHEET
```
    Name/Key of the property specifying the XSLT stylesheet to use when job are serialized in XML.
    
    See Also:
    
    Constant Field Values
  - KEY_ERROR_WRITER
```
public static final java.lang.String KEY_ERROR_WRITER
```
    Name/Key of the property specifying the error writer the UWS service must use.
    
    See Also:
    
    Constant Field Values
  - KEY_ADD_UWS_ACTIONS
```
public static final java.lang.String KEY_ADD_UWS_ACTIONS
```
    Name/Key of the property specifying a list of actions to add to the UWS service. By default, this list if empty ; only the default UWS actions exist.
    
    See Also:
    
    Constant Field Values
  - KEY_UWS_FACTORY
```
public static final java.lang.String KEY_UWS_FACTORY
```
    Name/Key of the property specifying the UWSFactory class to use instead of the default ConfigurableUWSFactory. Setting a value to this property could disable several properties of the UWS configuration file.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getProperty
```
public static final java.lang.String getProperty(java.util.Properties prop,
                                                 java.lang.String key)
```
    Read the asked property from the given Properties object.
    - The returned property value is trimmed (no space at the beginning and at the end of the string).
    - If the value is empty (length=0), NULL is returned.
    Parameters:
    
    prop - List of property
    
    key - Property whose the value is requested.
    
    Returns:
    
    Return property value.
  - extractJobListName
```
public static final java.lang.String extractJobListName(java.lang.String compoundPropertyName)
```
    Extract the job list name prefixing the given property name.
    Important: This function aims to be used for properties prefixed by a job list name such as REGEXP_JOB_THREAD, REGEXP_PARAMETERS, ...
    
    Parameters:
    
    compoundPropertyName - Property name prefixed by a job list name.
    
    Returns:
    
    The prefix of the given property name, or null if the given name is null or if it is not prefixed by a valid job list name.
  - isClassName
```
public static final boolean isClassName(java.lang.String value)
```
    Test whether a property value is a class name. Expected syntax: a non-empty string surrounded by brackets ('{' and '}'). Note: The class name itself is not checked!
    
    Parameters:
    
    value - Property value.
    
    Returns:
    
    true if the given value is formatted as a class name, false otherwise.
  - fetchClass
```
public static final <C> java.lang.Class<? extends C> fetchClass(java.lang.String value,
                                                                java.lang.String propertyName,
                                                                java.lang.Class<C> expectedType)
                                                         throws UWSException
```
    Fetch the class object corresponding to the class name provided between brackets in the given value.
    
    Parameters:
    
    value - Value which is supposed to contain the class name between brackets (see isClassName(String) for more details)
    
    propertyName - Name of the property associated with the parameter "value".
    
    expectedType - Type of the class expected to be returned ; it is also the type which parameterizes this function: C.
    
    Returns:
    
    The corresponding Class object.
    
    Throws:
    
    UWSException - If the class name is incorrect or if its type is not compatible with the parameterized type C (represented by the parameter "expectedType").
    
    See Also:
    
    isClassName(String)
  - hasConstructor
```
public static final <C> boolean hasConstructor(java.lang.String propValue,
                                               java.lang.String propName,
                                               java.lang.Class<C> expectedType,
                                               java.lang.Class<?>[] pTypes)
                                        throws UWSException
```
    Test whether the specified class has a constructor with the specified parameters.
    
    Parameters:
    
    propValue - Value which is supposed to contain the class name between brackets (see isClassName(String) for more details)
    
    propName - Name of the property associated with the parameter "propValue".
    
    expectedType - Type of the class expected to be returned ; it is also the type which parameterizes this function: C.
    
    pTypes - List of each constructor parameter type. Each type MUST be exactly the type declared in the class constructor to select. NULL or empty array if no parameter.
    
    Returns:
    
    true if the specified class has a constructor with the specified parameters, false otherwise.
    
    Throws:
    
    UWSException - If the class name is incorrect or if its type is not compatible with the parameterized type C (represented by the parameter "expectedType").
  - fetchConstructor
```
public static final <C> java.lang.reflect.Constructor<? extends C> fetchConstructor(java.lang.String propValue,
                                                                                    java.lang.String propName,
                                                                                    java.lang.Class<C> expectedType,
                                                                                    java.lang.Class<?>[] pTypes)
                                                                             throws UWSException
```
    Fetch the specified constructor of the class corresponding to the class name provided between brackets in the given value.
    IMPORTANT: The number and types of given parameters MUST match exactly to the list of parameter types.
    
    Parameters:
    
    propValue - Value which is supposed to contain the class name between brackets (see isClassName(String) for more details)
    
    propName - Name of the property associated with the parameter "propValue".
    
    expectedType - Type of the class expected to be returned ; it is also the type which parameterizes this function: C.
    
    pTypes - List of each constructor parameter type. Each type MUST be exactly the type declared in the class constructor to select. NULL or empty array if no parameter.
    
    Returns:
    
    The corresponding constructor.
    
    Throws:
    
    UWSException - If the class name is incorrect or if its type is not compatible with the parameterized type C (represented by the parameter "expectedType") or if the constructor with the specified parameters can not be found.
  - newInstance
```
public static final <C> C newInstance(java.lang.String propValue,
                                      java.lang.String propName,
                                      java.lang.Class<C> expectedType)
                               throws UWSException
```
    Create an instance of the specified class. The class name is expected to be surrounded by {} in the given value.
    
    The instance is created using the empty constructor of the specified class.
    
    Parameters:
    
    propValue - Value which is supposed to contain the class name between brackets (see isClassName(String) for more details)
    
    propName - Name of the property associated with the parameter "propValue".
    
    expectedType - Type of the class expected to be returned ; it is also the type which parameterizes this function: C.
    
    Returns:
    
    The corresponding instance.
    
    Throws:
    
    UWSException - If the class name is incorrect or if its type is not compatible with the parameterized type C (represented by the parameter "expectedType") or if the specified class has no empty constructor or if an error occurred while calling this constructor.
    
    See Also:
    
    isClassName(String), fetchClass(String, String, Class)
  - newInstance
```
public static final <C> C newInstance(java.lang.String propValue,
                                      java.lang.String propName,
                                      java.lang.Class<C> expectedType,
                                      java.lang.Class<?>[] pTypes,
                                      java.lang.Object[] parameters)
                               throws UWSException
```
    Create an instance of the specified class. The class name is expected to be surrounded by {} in the given value.
    
    IMPORTANT: The instance is created using the constructor whose the declaration matches exactly with the given list of parameter types. The number and types of given parameters MUST match exactly to the list of parameter types.
    
    Parameters:
    
    propValue - Value which is supposed to contain the class name between brackets (see isClassName(String) for more details)
    
    propName - Name of the property associated with the parameter "propValue".
    
    expectedType - Type of the class expected to be returned ; it is also the type which parameterizes this function: C.
    
    pTypes - List of each constructor parameter type. Each type MUST be exactly the type declared in the class constructor to select. NULL or empty array if no parameter.
    
    parameters - List of all constructor parameters. The number of object MUST match exactly the number of classes provided in the parameter pTypes. NULL or empty array if no parameter.
    
    Returns:
    
    The corresponding instance.
    
    Throws:
    
    UWSException - If the class name is incorrect or if its type is not compatible with the parameterized type C (represented by the parameter "expectedType") or if the constructor with the specified parameters can not be found or if an error occurred while calling this constructor.
    
    See Also:
    
    isClassName(String), fetchClass(String, String, Class)
  - parseLimit
```
public static final long parseLimit(java.lang.String value,
                                    java.lang.String propertyName)
                             throws UWSException
```
    Lets parsing a limit (for upload, ...) with its numeric value and its unit.
    
    Here is the expected syntax: num_val[unit]. Where unit is optional and should be one of the following values: B, kB, MB or GB. If the unit is not specified, it is set by default to BYTES.
    
    Note: If the value is strictly less than 0 (whatever is the unit), the returned value will be -1.
    
    Parameters:
    
    value - Property value (must follow the limit syntax: num_val[unit] ; ex: 20kB or 2000 (for 2000 bytes)).
    
    propertyName - Name of the property which specify the limit.
    
    Returns:
    
    The expressed unit in bytes or -1, if the given value was incorrect or negative.
    
    Throws:
    
    UWSException - If the syntax is incorrect or if a not allowed unit has been used.

Class UWSConfiguration

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UWS_CONF_PARAMETER

DEFAULT_UWS_CONF_FILE

KEY_HOME_PAGE

KEY_HOME_PAGE_MIME_TYPE

KEY_SERVICE_NAME

KEY_SERVICE_DESCRIPTION

KEY_JOB_LISTS

REGEXP_JOB_LIST_NAME

KEY_JOB_THREAD

REGEXP_JOB_THREAD

KEY_PARAMETERS

REGEXP_PARAMETERS

KEY_DEFAULT_EXECUTION_DURATION

REGEXP_DEFAULT_EXEC_DURATION

KEY_MAX_EXECUTION_DURATION

REGEXP_MAX_EXEC_DURATION

DEFAULT_EXECUTION_DURATION

KEY_MAX_RUNNING_JOBS

REGEXP_MAX_RUNNING_JOBS

KEY_EXECUTION_MANAGER

REGEXP_EXECUTION_MANAGER

KEY_DEFAULT_DESTRUCTION_INTERVAL

REGEXP_DEFAULT_DESTRUCTION_INTERVAL

KEY_MAX_DESTRUCTION_INTERVAL

KEY_REGEXP_MAX_DESTRUCTION_INTERVAL

KEY_DESTRUCTION_MANAGER

REGEXP_DESTRUCTION_MANAGER

KEY_FILE_MANAGER

VALUE_LOCAL

DEFAULT_FILE_MANAGER

KEY_FILE_ROOT_PATH

KEY_DIRECTORY_PER_USER

DEFAULT_DIRECTORY_PER_USER

KEY_GROUP_USER_DIRECTORIES

DEFAULT_GROUP_USER_DIRECTORIES

KEY_LOGGER

DEFAULT_LOGGER

KEY_MIN_LOG_LEVEL

KEY_LOG_ROTATION

SLF4J_LOGGER

KEY_BACKUP_FREQUENCY

VALUE_NEVER

VALUE_USER_ACTION

DEFAULT_BACKUP_FREQUENCY

KEY_BACKUP_BY_USER

DEFAULT_BACKUP_BY_USER

KEY_USER_IDENTIFIER

KEY_REQUEST_PARSER

KEY_ADD_SERIALIZERS

KEY_XSLT_STYLESHEET

KEY_ERROR_WRITER

KEY_ADD_UWS_ACTIONS

KEY_UWS_FACTORY

Method Detail

getProperty

extractJobListName

isClassName

fetchClass

hasConstructor

fetchConstructor

newInstance

newInstance

parseLimit