PASharedProperties (scheduling 14.2.0-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<PASharedProperties>
- - org.ow2.proactive.core.properties.PASharedProperties

All Implemented Interfaces:

Serializable, Comparable<PASharedProperties>, PACommonProperties
```
public enum PASharedProperties
extends Enum<PASharedProperties>
implements PACommonProperties
```
PASharedProperties contains all shared properties.

Since:

ProActive 10.1 $Id$

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALLOWED_DOMAINS` List of domain names that can be used during a login (can be a list of windows domain names or a list of tenants in Multi-LDAP configuration)
`AUTH_JAAS_PATH` path to the Jaas configuration file which defines what modules are available for internal authentication
`AUTH_PRIVKEY_PATH` Path to the private key file which is used to decrypt credentials passed to the jaas module
`AUTH_PUBKEY_PATH` Path to the public key file which is used to encrypt credentials for authentication
`AUTHENTICATION_DIR` authentication home directory
`CREATE_CREDENTIALS_WHEN_LOGIN` create encrypted credentials file when the user logs in, used by several components such as the job-planner
`FAILED_LOGIN_MAX_ATTEMPTS` maximum number of failed attempts accepted in the given time window (to prevent brute force attacks).
`FAILED_LOGIN_RENEW_MINUTES` time window in minutes after which a failed login attempt is forgotten
`GROUP_FILENAME` group file name
`KEYCLOAK_CONFIG_FILE_PATH` Keycloak configuration file path, used to set Keycloak configuration properties If this file path is relative, the path is evaluated from the Scheduler dir (ie application's root dir) with the variable defined below : pa.scheduler.home.
`LAZY_FETCH_SCRIPT` Controls the fetch mode of scripts defined by URL.
`LDAP_CONFIG_FILE_PATH` LDAP Authentication configuration file path, used to set LDAP configuration properties If this file path is relative, the path is evaluated from the Scheduler dir (ie application's root dir) with the variable defined below : pa.scheduler.home.
`LEGACY_ENCRYPTION` When using legacy encryption, passwords are stored in login.cfg using symmetric key encryption, instead of hash/salt.
`LOGIN_FILENAME` login file name
`MULTI_LDAP_CONFIG` Support for multi-ldap login configuration.
`PASSWORD_STRENGTH_ENABLE` Enable password strength check, used when a user is created or modified
`PASSWORD_STRENGTH_ERROR_MESSAGE` Textual error message when password strength is not met
`PASSWORD_STRENGTH_REGEXP` Regular expression used to control the password strength (default is 8 to 32 characters with at least an uppercase letter, a lowercase letter, a digit and a symbol)
`PROPERTIES_CRYPT_KEY` Key used when decrypting properties
`SERVER_BACKUP` if backup is enabled
`SERVER_BACKUP_DESTINATION` a relative or absolute path to a folder (where the backup files should be stored)
`SERVER_BACKUP_PERIOD` cron expression which defines when backup should be performed (every day by default).
`SERVER_BACKUP_POSSIBLE_DELAY` backup mechanism may wait possible.delay (in seconds) until all currently running tasks are finished.
`SERVER_BACKUP_TARGETS` comma-separated list of folder and/or files which need to be backup
`SERVER_BACKUP_WINDOWS` determines how many backups should be kept
`SHARED_HOME` reusing existing rm home property
`TENANT_FILENAME` tenant file name
`USE_DOMAIN_IN_CREDENTIALS_FILE` use domain in credentials file name
`USERNAME_REGEXP` Regular expression used to control the username format when logging in.

Field Summary

Fields
Modifier and Type Field and Description

static String PA_SHARED_PROPERTIES_FILEPATH

static String PA_SHARED_PROPERTIES_RELATIVE_FILEPATH

Fields
Modifier and Type	Field and Description
`static String`	`PA_SHARED_PROPERTIES_FILEPATH`
`static String`	`PA_SHARED_PROPERTIES_RELATIVE_FILEPATH`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getAbsolutePath(String userPath)` Get the absolute path of the given path. It the path is absolute, then it is returned.
`String`	`getCmdLine()` Returns the string to be passed on the command line The property surrounded by '-D' and '='
`String`	`getConfigurationDefaultRelativeFilePath()` Returns the default relative path used to store the property file
`String`	`getConfigurationFilePathPropertyName()` Returns the System property name used to store the configuration file path
`String`	`getKey()` Get the key.
`static Map<String,Object>`	`getPropertiesAsHashMap()` Return all properties as a HashMap.
`PropertyType`	`getType()` Return the type of the given properties.
`boolean`	`getValueAsBoolean()` Returns the value of this property as a boolean.
`int`	`getValueAsInt()` Returns the value of this property as an integer.
`List<String>`	`getValueAsList(String separator)` Returns the value of this property as a List of strings.
`List<String>`	`getValueAsList(String separator, boolean allowEmpty)` Returns the value of this property as a List of strings.
`long`	`getValueAsLong()` Returns the value of this property as a long integer.
`String`	`getValueAsString()` Returns the value of this property as a string.
`String`	`getValueAsStringOrNull()` Returns the value of this property as a string.
`boolean`	`isSet()` Return true if this property is set or has a default value, false otherwise.
`protected static void`	`loadProperties(String filename)` Load the properties from the given file.
`void`	`loadPropertiesFromFile(String filename)` Load the properties from the given file.
`static void`	`reload()`
`void`	`reloadConfiguration()` Reload the properties using the default property file configuration This method will clean every loaded properties before.
`String`	`toString()`
`void`	`unSet()` Unset this property, if this property has a default value, calling unSet will revert to the default.
`static void`	`updateProperties(String filename)` Override properties defined in the default configuration file, by properties defined in another file.
`void`	`updateProperty(String value)` Set the value of this property to the given one.
`static PASharedProperties`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static PASharedProperties[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SHARED_HOME
```
public static final PASharedProperties SHARED_HOME
```
    reusing existing rm home property
  - FAILED_LOGIN_MAX_ATTEMPTS
```
public static final PASharedProperties FAILED_LOGIN_MAX_ATTEMPTS
```
    maximum number of failed attempts accepted in the given time window (to prevent brute force attacks). The mechanism can be disabled by using a zero or negative value
  - FAILED_LOGIN_RENEW_MINUTES
```
public static final PASharedProperties FAILED_LOGIN_RENEW_MINUTES
```
    time window in minutes after which a failed login attempt is forgotten
  - CREATE_CREDENTIALS_WHEN_LOGIN
```
public static final PASharedProperties CREATE_CREDENTIALS_WHEN_LOGIN
```
    create encrypted credentials file when the user logs in, used by several components such as the job-planner
  - USE_DOMAIN_IN_CREDENTIALS_FILE
```
public static final PASharedProperties USE_DOMAIN_IN_CREDENTIALS_FILE
```
    use domain in credentials file name
  - LEGACY_ENCRYPTION
```
public static final PASharedProperties LEGACY_ENCRYPTION
```
    When using legacy encryption, passwords are stored in login.cfg using symmetric key encryption, instead of hash/salt. Default to true for backward compatibility
  - AUTHENTICATION_DIR
```
public static final PASharedProperties AUTHENTICATION_DIR
```
    authentication home directory
  - AUTH_JAAS_PATH
```
public static final PASharedProperties AUTH_JAAS_PATH
```
    path to the Jaas configuration file which defines what modules are available for internal authentication
  - LDAP_CONFIG_FILE_PATH
```
public static final PASharedProperties LDAP_CONFIG_FILE_PATH
```
    LDAP Authentication configuration file path, used to set LDAP configuration properties If this file path is relative, the path is evaluated from the Scheduler dir (ie application's root dir) with the variable defined below : pa.scheduler.home. else, the path is absolute, so the path is directly interpreted
  - KEYCLOAK_CONFIG_FILE_PATH
```
public static final PASharedProperties KEYCLOAK_CONFIG_FILE_PATH
```
    Keycloak configuration file path, used to set Keycloak configuration properties If this file path is relative, the path is evaluated from the Scheduler dir (ie application's root dir) with the variable defined below : pa.scheduler.home. else, the path is absolute, so the path is directly interpreted
  - ALLOWED_DOMAINS
```
public static final PASharedProperties ALLOWED_DOMAINS
```
    List of domain names that can be used during a login (can be a list of windows domain names or a list of tenants in Multi-LDAP configuration)
  - MULTI_LDAP_CONFIG
```
public static final PASharedProperties MULTI_LDAP_CONFIG
```
    Support for multi-ldap login configuration. This property must be defined using a list of the following form: domain1:path_to_domain1.cfg,domain2:path_to_domain2.cfg, etc domain names must be lowercase and must also be configured in pa.allowed.domains
  - AUTH_PRIVKEY_PATH
```
public static final PASharedProperties AUTH_PRIVKEY_PATH
```
    Path to the private key file which is used to decrypt credentials passed to the jaas module
  - AUTH_PUBKEY_PATH
```
public static final PASharedProperties AUTH_PUBKEY_PATH
```
    Path to the public key file which is used to encrypt credentials for authentication
  - USERNAME_REGEXP
```
public static final PASharedProperties USERNAME_REGEXP
```
    Regular expression used to control the username format when logging in. Always enabled to prevent injection attacks on 3rd-party authentication like LDAP
  - PASSWORD_STRENGTH_ENABLE
```
public static final PASharedProperties PASSWORD_STRENGTH_ENABLE
```
    Enable password strength check, used when a user is created or modified
  - PASSWORD_STRENGTH_REGEXP
```
public static final PASharedProperties PASSWORD_STRENGTH_REGEXP
```
    Regular expression used to control the password strength (default is 8 to 32 characters with at least an uppercase letter, a lowercase letter, a digit and a symbol)
  - PASSWORD_STRENGTH_ERROR_MESSAGE
```
public static final PASharedProperties PASSWORD_STRENGTH_ERROR_MESSAGE
```
    Textual error message when password strength is not met
  - LOGIN_FILENAME
```
public static final PASharedProperties LOGIN_FILENAME
```
    login file name
  - GROUP_FILENAME
```
public static final PASharedProperties GROUP_FILENAME
```
    group file name
  - TENANT_FILENAME
```
public static final PASharedProperties TENANT_FILENAME
```
    tenant file name
  - PROPERTIES_CRYPT_KEY
```
public static final PASharedProperties PROPERTIES_CRYPT_KEY
```
    Key used when decrypting properties
  - SERVER_BACKUP
```
public static final PASharedProperties SERVER_BACKUP
```
    if backup is enabled
  - SERVER_BACKUP_PERIOD
```
public static final PASharedProperties SERVER_BACKUP_PERIOD
```
    cron expression which defines when backup should be performed (every day by default). A UNIX crontab-like expression in the following format: (minutes) (hours) (days of month) (month) (days of week)
  - SERVER_BACKUP_WINDOWS
```
public static final PASharedProperties SERVER_BACKUP_WINDOWS
```
    determines how many backups should be kept
  - SERVER_BACKUP_DESTINATION
```
public static final PASharedProperties SERVER_BACKUP_DESTINATION
```
    a relative or absolute path to a folder (where the backup files should be stored)
  - SERVER_BACKUP_TARGETS
```
public static final PASharedProperties SERVER_BACKUP_TARGETS
```
    comma-separated list of folder and/or files which need to be backup
  - SERVER_BACKUP_POSSIBLE_DELAY
```
public static final PASharedProperties SERVER_BACKUP_POSSIBLE_DELAY
```
    backup mechanism may wait possible.delay (in seconds) until all currently running tasks are finished. if some tasks are still running after this delay, the backup will not be performed
  - LAZY_FETCH_SCRIPT
```
public static final PASharedProperties LAZY_FETCH_SCRIPT
```
    Controls the fetch mode of scripts defined by URL. If true (default), it means that the script is fetched at task execution time If false, it means that the script is fetch when the job is submitted to the scheduler
- Field Detail
  - PA_SHARED_PROPERTIES_FILEPATH
```
public static final String PA_SHARED_PROPERTIES_FILEPATH
```
    See Also:
    
    Constant Field Values
  - PA_SHARED_PROPERTIES_RELATIVE_FILEPATH
```
public static final String PA_SHARED_PROPERTIES_RELATIVE_FILEPATH
```
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static PASharedProperties[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (PASharedProperties c : PASharedProperties.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static PASharedProperties valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - loadProperties
```
protected static void loadProperties(String filename)
```
    Load the properties from the given file. This method will clean every loaded properties before.
    
    Parameters:
    
    filename - the file containing the properties to be loaded.
  - reload
```
public static void reload()
```
  - updateProperties
```
public static void updateProperties(String filename)
```
    Override properties defined in the default configuration file, by properties defined in another file. Call this method implies the default properties to be loaded
    
    Parameters:
    
    filename - path of file containing some properties to override
  - getPropertiesAsHashMap
```
public static Map<String,Object> getPropertiesAsHashMap()
```
    Return all properties as a HashMap.
  - getAbsolutePath
```
public static String getAbsolutePath(String userPath)
```
    Get the absolute path of the given path.
    It the path is absolute, then it is returned. If the path is relative, then the RM_home directory is concatenated in front of the given string.
    
    Parameters:
    
    userPath - the path to check transform.
    
    Returns:
    
    the absolute path of the given path.
  - getConfigurationFilePathPropertyName
```
public String getConfigurationFilePathPropertyName()
```
    Description copied from interface: PACommonProperties
    
    Returns the System property name used to store the configuration file path
    
    Specified by:
    
    getConfigurationFilePathPropertyName in interface PACommonProperties
    
    Returns:
    
    system property name
  - getConfigurationDefaultRelativeFilePath
```
public String getConfigurationDefaultRelativeFilePath()
```
    Description copied from interface: PACommonProperties
    
    Returns the default relative path used to store the property file
    
    Specified by:
    
    getConfigurationDefaultRelativeFilePath in interface PACommonProperties
    
    Returns:
    
    default file path
  - loadPropertiesFromFile
```
public void loadPropertiesFromFile(String filename)
```
    Description copied from interface: PACommonProperties
    
    Load the properties from the given file. This method will clean every loaded properties before.
    
    Specified by:
    
    loadPropertiesFromFile in interface PACommonProperties
    
    Parameters:
    
    filename - the file containing the properties to be loaded.
  - reloadConfiguration
```
public void reloadConfiguration()
```
    Description copied from interface: PACommonProperties
    
    Reload the properties using the default property file configuration This method will clean every loaded properties before.
    
    Specified by:
    
    reloadConfiguration in interface PACommonProperties
  - getKey
```
public String getKey()
```
    Description copied from interface: PACommonProperties
    
    Get the key.
    
    Specified by:
    
    getKey in interface PACommonProperties
    
    Returns:
    
    the key.
  - updateProperty
```
public void updateProperty(String value)
```
    Description copied from interface: PACommonProperties
    
    Set the value of this property to the given one.
    
    Specified by:
    
    updateProperty in interface PACommonProperties
    
    Parameters:
    
    value - the new value to set.
  - isSet
```
public boolean isSet()
```
    Description copied from interface: PACommonProperties
    
    Return true if this property is set or has a default value, false otherwise.
    
    Specified by:
    
    isSet in interface PACommonProperties
    
    Returns:
    
    true if this property is set, false otherwise.
  - unSet
```
public void unSet()
```
    Description copied from interface: PACommonProperties
    
    Unset this property, if this property has a default value, calling unSet will revert to the default.
    
    Specified by:
    
    unSet in interface PACommonProperties
  - getCmdLine
```
public String getCmdLine()
```
    Description copied from interface: PACommonProperties
    
    Returns the string to be passed on the command line The property surrounded by '-D' and '='
    
    Specified by:
    
    getCmdLine in interface PACommonProperties
    
    Returns:
    
    the string to be passed on the command line
  - getValueAsInt
```
public int getValueAsInt()
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as an integer. If value is not an integer, an exception will be thrown.
    
    Specified by:
    
    getValueAsInt in interface PACommonProperties
    
    Returns:
    
    the value of this property.
  - getValueAsLong
```
public long getValueAsLong()
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as a long integer. If value is not a long integer, an exception will be thrown.
    
    Specified by:
    
    getValueAsLong in interface PACommonProperties
    
    Returns:
    
    the value of this property.
  - getValueAsString
```
public String getValueAsString()
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as a string.
    
    Specified by:
    
    getValueAsString in interface PACommonProperties
    
    Returns:
    
    the value of this property.
  - getValueAsStringOrNull
```
public String getValueAsStringOrNull()
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as a string. If the property is not defined or empty, then null is returned
    
    Specified by:
    
    getValueAsStringOrNull in interface PACommonProperties
    
    Returns:
    
    the value of this property.
  - getValueAsBoolean
```
public boolean getValueAsBoolean()
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as a boolean. If value is not a boolean, an exception will be thrown.
    The behavior of this method is the same as the Boolean.parseBoolean(String s).
    
    Specified by:
    
    getValueAsBoolean in interface PACommonProperties
    
    Returns:
    
    the value of this property or false if it's not defined.
  - getValueAsList
```
public List<String> getValueAsList(String separator)
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as a List of strings. equivalent of getValueAsList(separator, false)
    
    Specified by:
    
    getValueAsList in interface PACommonProperties
    
    Parameters:
    
    separator - the separator to use
    
    Returns:
    
    the list of values of this property.
  - getValueAsList
```
public List<String> getValueAsList(String separator,
                                   boolean allowEmpty)
```
    Description copied from interface: PACommonProperties
    
    Returns the value of this property as a List of strings.
    
    Specified by:
    
    getValueAsList in interface PACommonProperties
    
    Parameters:
    
    separator - the separator to use
    
    allowEmpty - allow empty values in the list
    
    Returns:
    
    the list of values of this property.
  - getType
```
public PropertyType getType()
```
    Description copied from interface: PACommonProperties
    
    Return the type of the given properties.
    
    Specified by:
    
    getType in interface PACommonProperties
    
    Returns:
    
    the type of the given properties.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<PASharedProperties>
    
    See Also:
    
    Enum.toString()

Enum PASharedProperties

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SHARED_HOME

FAILED_LOGIN_MAX_ATTEMPTS

FAILED_LOGIN_RENEW_MINUTES

CREATE_CREDENTIALS_WHEN_LOGIN

USE_DOMAIN_IN_CREDENTIALS_FILE

LEGACY_ENCRYPTION

AUTHENTICATION_DIR

AUTH_JAAS_PATH

LDAP_CONFIG_FILE_PATH

KEYCLOAK_CONFIG_FILE_PATH

ALLOWED_DOMAINS

MULTI_LDAP_CONFIG

AUTH_PRIVKEY_PATH

AUTH_PUBKEY_PATH

USERNAME_REGEXP

PASSWORD_STRENGTH_ENABLE

PASSWORD_STRENGTH_REGEXP

PASSWORD_STRENGTH_ERROR_MESSAGE

LOGIN_FILENAME

GROUP_FILENAME

TENANT_FILENAME

PROPERTIES_CRYPT_KEY

SERVER_BACKUP

SERVER_BACKUP_PERIOD

SERVER_BACKUP_WINDOWS

SERVER_BACKUP_DESTINATION

SERVER_BACKUP_TARGETS

SERVER_BACKUP_POSSIBLE_DELAY

LAZY_FETCH_SCRIPT

Field Detail

PA_SHARED_PROPERTIES_FILEPATH

PA_SHARED_PROPERTIES_RELATIVE_FILEPATH

Method Detail

values

valueOf

loadProperties

reload

updateProperties

getPropertiesAsHashMap

getAbsolutePath

getConfigurationFilePathPropertyName

getConfigurationDefaultRelativeFilePath

loadPropertiesFromFile

reloadConfiguration

getKey

updateProperty

isSet

unSet

getCmdLine

getValueAsInt

getValueAsLong

getValueAsString

getValueAsStringOrNull

getValueAsBoolean

getValueAsList

getValueAsList

getType

toString