@PublicAPI public enum PASchedulerProperties extends Enum<PASchedulerProperties> implements PACommonProperties
Enum Constant and Description |
---|
CATALOG_REST_URL
Catalog rest url
|
DATASPACE_DEFAULTGLOBAL_HOSTNAME |
DATASPACE_DEFAULTGLOBAL_LOCALPATH |
DATASPACE_DEFAULTGLOBAL_URL
Several URLs can be specified, separated by space
|
DATASPACE_DEFAULTINPUT_HOSTNAME
Host name from which the localpath is accessible
|
DATASPACE_DEFAULTINPUT_LOCALPATH
Default INPUT space path.
|
DATASPACE_DEFAULTINPUT_URL
Several URLs can be specified (which should all point to the same physical space, in that case, urls must be separated by spaces.
|
DATASPACE_DEFAULTOUTPUT_HOSTNAME |
DATASPACE_DEFAULTOUTPUT_LOCALPATH |
DATASPACE_DEFAULTOUTPUT_URL
Several URLs can be specified, separated by space
|
DATASPACE_DEFAULTUSER_HOSTNAME |
DATASPACE_DEFAULTUSER_LOCALPATH |
DATASPACE_DEFAULTUSER_URL
Several URLs can be specified, separated by space
|
EMAIL_NOTIFICATIONS_CONFIGURATION |
EMAIL_NOTIFICATIONS_ENABLED |
EMAIL_NOTIFICATIONS_SENDER_ADDRESS |
EXECUTE_SCRIPT_AUTHORIZED_DIR
If set to non-null value the scheduler can executes only forkenvironment and clean scripts from
this directory.
|
EXECUTE_SCRIPT_AUTHORIZED_DIR_REFRESHPERIOD
The pa.scheduler.script.authorized.dir is browsed every refreshperiod time to load authorized scripts.
|
FILE_ENCODING
File encoding used by the scheduler
|
JOB_REMOVE_FROM_DB
Remove job in dataBase when removing it from scheduler.
|
LICENSE_SCHEDULING_POLICY_CONFIGURATION |
LICENSE_SCHEDULING_POLICY_DATABASE
location of the jdbm database for persistent license registrations
|
LOGS_FORWARDING_PROVIDER
Log forwarder provider
|
NUMBER_OF_EXECUTION_ON_FAILURE
Maximum number of execution for a task in case of failure (node down)
|
POLICY_RELOAD_FREQUENCY_IN_SECONDS
Refresh time to reload the security policy file (security.java.policy-server)
|
REEXECUTION_INITIAL_WAITING_TIME
Initial time to wait before the re-execution of a task.
|
RESOURCE_MANAGER_CONNECTION_TIMEOUT
Set a timeout for initial connection to the RM connection (in ms)
|
RESOURCE_MANAGER_CREDS
Path to the Scheduler credentials file for RM authentication
|
RESOURCE_MANAGER_SINGLE_CONNECTION
Use single or multiple connection to RM
(If true) the scheduler user will do the requests to rm
(If false) each Scheduler users have their own connection to RM using same credentials
|
SCHEDULER_ACCOUNT_REFRESH_RATE
Accounting refresh rate from the database in seconds
|
SCHEDULER_AUTH_JAAS_PATH
path to the Jaas configuration file which defines what modules are available for
internal authentication
|
SCHEDULER_AUTH_PRIVKEY_PATH
path to the private key file which is used to decrypt credentials passed to the jaas module
|
SCHEDULER_AUTH_PUBKEY_PATH
path to the public key file which is used to encrypt credentials for authentication
|
SCHEDULER_AUTOMATIC_REMOVED_JOB_CRON_EXPR
Cron expression to automatically remove finished jobs
|
SCHEDULER_AUTOMATIC_REMOVED_JOB_DELAY
Delay to wait between a job is terminated and removing the it from Scheduler (0 = infinite)
|
SCHEDULER_CLIENT_POOL_NBTHREAD
Number of threads used to execute client requests
|
SCHEDULER_CREATE_CREDENTIALS_WHEN_LOGIN
Creates a credential file (username.cred) for each successful login in the authentication folder
|
SCHEDULER_DB_FETCH_TASK_RESULTS_BATCH_SIZE |
SCHEDULER_DB_HIBERNATE_CONFIG
Hibernate configuration file (relative to home directory)
|
SCHEDULER_DB_HIBERNATE_DROPDB
Drop database before creating a new one
If this value is true, the database will be dropped and then re-created
If this value is false, database will be updated from the existing one.
|
SCHEDULER_DB_LOAD_JOB_PERIOD
This property is used to limit number of finished jobs loaded from the database
at scheduler startup.
|
SCHEDULER_DB_RECOVERY_LOAD_JOBS_BATCH_SIZE |
SCHEDULER_DB_TRANSACTION_DAMPING_FACTOR |
SCHEDULER_DB_TRANSACTION_MAXIMUM_RETRIES |
SCHEDULER_DB_TRANSACTION_SLEEP_DELAY |
SCHEDULER_DEFAULT_POLICY
Scheduler default policy full name.
|
SCHEDULER_FINISHED_JOBS_LRU_CACHE_SIZE |
SCHEDULER_GROUP_FILENAME
Group default filename
|
SCHEDULER_HOME
Scheduler home directory
|
SCHEDULER_HOUSEKEEPING_SCHEDULED_POOL_NBTHREAD
Number of threads used to handle scheduled operations related to housekeeping
|
SCHEDULER_INTERNAL_POOL_NBTHREAD
Number of threads used to execute internal scheduling operations
|
SCHEDULER_JMX_CONNECTOR_NAME
Name of the JMX MBean for the scheduler
|
SCHEDULER_JMX_PORT
Port of the JMX service.
|
SCHEDULER_JOB_LOGS_LOCATION |
SCHEDULER_JOB_LOGS_MAX_SIZE |
SCHEDULER_JOB_LOGS_PATTERN |
SCHEDULER_JOB_SUBMISSION_DETAILED_LOGGING |
SCHEDULER_KILL_DELAY
Time in milliseconds before sending a kill request to the scheduler.
|
SCHEDULER_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.
|
SCHEDULER_LICENSE_POLICY_CONFIGURATION
Path of the license properties file.
|
SCHEDULER_LISTENERS_THREADNUMBER
Maximum number of threads used to send events to clients.
|
SCHEDULER_LOGIN_FILENAME
Login default file name
|
SCHEDULER_LOGIN_METHOD
Property that define the method that have to be used for logging users to the Scheduler
|
SCHEDULER_MEM_MONITORING_FREQ
Defines the cron expression for the db sizes polling
|
SCHEDULER_NODE_PING_ATTEMPTS
Scheduler number of node ping attempts before restarting the task.
|
SCHEDULER_NODE_PING_FREQUENCY
Scheduler node ping frequency in s.
|
SCHEDULER_PARALLEL_SCHEDULER_STATE_RECOVER_NBTHREAD
The number of threads in the thread pool that serves to recover running tasks in parallel at scheduler start up
|
SCHEDULER_PARALLEL_SCHEDULER_STATE_RECOVER_TIMEOUT
The timeout - to be used in minutes - for the scheduler state to be fully recovered
|
SCHEDULER_POLICY_NBTASKPERLOOP
Defines the maximum number of tasks to be scheduled in each scheduling loop.
|
SCHEDULER_PORTAL_CONFIGURATION |
SCHEDULER_REMOVED_JOB_DELAY
Delay to wait between getting a job result and removing the job concerned (0 = infinite)
|
SCHEDULER_REST_URL
Scheduler rest url
|
SCHEDULER_RMCONNECTION_ATTEMPTS
Scheduler maximum number of reconnection attempts
|
SCHEDULER_RMCONNECTION_AUTO_CONNECT
Scheduler auto reconnection to the RM when the connection is down
|
SCHEDULER_RMCONNECTION_TIMESPAN
Scheduler time span between two reconnection attempts
|
SCHEDULER_RRD_DATABASE_NAME
RRD data base with statistic history
|
SCHEDULER_RRD_STEP
RRD data base step in seconds
|
SCHEDULER_SCHEDULED_POOL_NBTHREAD
Number of threads used to handle scheduled operations other than housekeeping operations
|
SCHEDULER_STARTSCRIPTS_PATHS
List of the scripts paths to execute at scheduler start.
|
SCHEDULER_STARTTASK_THREADNUMBER
Maximum number of threads used for the start task action.
|
SCHEDULER_STARTTASK_TIMEOUT
Timeout for the start task action.
|
SCHEDULER_SYNCHRONIZATION_DATABASE
location of the jdbm database for persistent channels
|
SCHEDULER_TASK_PINGER_POOL_NBTHREAD
Number of threads used to ping tasks
|
SCHEDULER_TIME_OUT
Scheduler main loop time out
|
SCHEDULER_USER_SESSION_TIME
User session time (user is automatically disconnect after this time if no request is made to the scheduler)
negative number indicates that session is infinite (value specified in second)
|
TASK_FORK
If true script tasks are ran in a forked JVM, if false they are ran in the node's JVM
|
TASK_RUNASME
If true tasks are always ran in RunAsMe mode (implies automatically fork), if false, the user can choose whether to run the task in runasme mode or not
|
TASKS_PAGE_SIZE
Number of tasks to fetch per page when pagination is used
|
Modifier and Type | Field and Description |
---|---|
static String |
PA_SCHEDULER_PROPERTIES_FILEPATH |
static String |
PA_SCHEDULER_PROPERTIES_RELATIVE_FILEPATH |
Modifier and Type | Method and Description |
---|---|
static String |
getAbsolutePath(String userPath)
Get the absolute path of the given path.
|
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.
|
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.
|
static void |
load() |
static void |
loadProperties(String filename)
Load the properties from the given file.
|
void |
loadPropertiesFromFile(String filename)
Load the properties from the given file.
|
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 PASchedulerProperties |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static PASchedulerProperties[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final PASchedulerProperties SCHEDULER_DEFAULT_POLICY
public static final PASchedulerProperties SCHEDULER_POLICY_NBTASKPERLOOP
public static final PASchedulerProperties SCHEDULER_LICENSE_POLICY_CONFIGURATION
public static final PASchedulerProperties SCHEDULER_TIME_OUT
public static final PASchedulerProperties SCHEDULER_RMCONNECTION_AUTO_CONNECT
public static final PASchedulerProperties SCHEDULER_RMCONNECTION_TIMESPAN
public static final PASchedulerProperties SCHEDULER_RMCONNECTION_ATTEMPTS
public static final PASchedulerProperties SCHEDULER_NODE_PING_FREQUENCY
public static final PASchedulerProperties SCHEDULER_NODE_PING_ATTEMPTS
public static final PASchedulerProperties SCHEDULER_KILL_DELAY
public static final PASchedulerProperties SCHEDULER_CLIENT_POOL_NBTHREAD
public static final PASchedulerProperties SCHEDULER_INTERNAL_POOL_NBTHREAD
public static final PASchedulerProperties SCHEDULER_TASK_PINGER_POOL_NBTHREAD
public static final PASchedulerProperties SCHEDULER_SCHEDULED_POOL_NBTHREAD
public static final PASchedulerProperties SCHEDULER_HOUSEKEEPING_SCHEDULED_POOL_NBTHREAD
public static final PASchedulerProperties SCHEDULER_PARALLEL_SCHEDULER_STATE_RECOVER_NBTHREAD
public static final PASchedulerProperties SCHEDULER_PARALLEL_SCHEDULER_STATE_RECOVER_TIMEOUT
public static final PASchedulerProperties SCHEDULER_JMX_CONNECTOR_NAME
public static final PASchedulerProperties SCHEDULER_JMX_PORT
public static final PASchedulerProperties SCHEDULER_RRD_DATABASE_NAME
public static final PASchedulerProperties SCHEDULER_RRD_STEP
public static final PASchedulerProperties SCHEDULER_ACCOUNT_REFRESH_RATE
public static final PASchedulerProperties SCHEDULER_USER_SESSION_TIME
public static final PASchedulerProperties SCHEDULER_STARTTASK_TIMEOUT
public static final PASchedulerProperties SCHEDULER_STARTTASK_THREADNUMBER
public static final PASchedulerProperties SCHEDULER_LISTENERS_THREADNUMBER
public static final PASchedulerProperties SCHEDULER_STARTSCRIPTS_PATHS
public static final PASchedulerProperties SCHEDULER_AUTH_JAAS_PATH
public static final PASchedulerProperties SCHEDULER_AUTH_PRIVKEY_PATH
public static final PASchedulerProperties SCHEDULER_AUTH_PUBKEY_PATH
public static final PASchedulerProperties SCHEDULER_LDAP_CONFIG_FILE_PATH
public static final PASchedulerProperties SCHEDULER_LOGIN_FILENAME
public static final PASchedulerProperties SCHEDULER_GROUP_FILENAME
public static final PASchedulerProperties SCHEDULER_LOGIN_METHOD
public static final PASchedulerProperties POLICY_RELOAD_FREQUENCY_IN_SECONDS
public static final PASchedulerProperties SCHEDULER_CREATE_CREDENTIALS_WHEN_LOGIN
public static final PASchedulerProperties SCHEDULER_REMOVED_JOB_DELAY
public static final PASchedulerProperties SCHEDULER_AUTOMATIC_REMOVED_JOB_DELAY
public static final PASchedulerProperties SCHEDULER_AUTOMATIC_REMOVED_JOB_CRON_EXPR
public static final PASchedulerProperties JOB_REMOVE_FROM_DB
public static final PASchedulerProperties FILE_ENCODING
public static final PASchedulerProperties SCHEDULER_FINISHED_JOBS_LRU_CACHE_SIZE
public static final PASchedulerProperties REEXECUTION_INITIAL_WAITING_TIME
public static final PASchedulerProperties NUMBER_OF_EXECUTION_ON_FAILURE
public static final PASchedulerProperties TASK_FORK
public static final PASchedulerProperties TASK_RUNASME
public static final PASchedulerProperties TASKS_PAGE_SIZE
public static final PASchedulerProperties EXECUTE_SCRIPT_AUTHORIZED_DIR
public static final PASchedulerProperties EXECUTE_SCRIPT_AUTHORIZED_DIR_REFRESHPERIOD
public static final PASchedulerProperties DATASPACE_DEFAULTINPUT_URL
public static final PASchedulerProperties DATASPACE_DEFAULTINPUT_LOCALPATH
public static final PASchedulerProperties DATASPACE_DEFAULTINPUT_HOSTNAME
public static final PASchedulerProperties DATASPACE_DEFAULTOUTPUT_URL
public static final PASchedulerProperties DATASPACE_DEFAULTOUTPUT_LOCALPATH
public static final PASchedulerProperties DATASPACE_DEFAULTOUTPUT_HOSTNAME
public static final PASchedulerProperties DATASPACE_DEFAULTGLOBAL_URL
public static final PASchedulerProperties DATASPACE_DEFAULTGLOBAL_LOCALPATH
public static final PASchedulerProperties DATASPACE_DEFAULTGLOBAL_HOSTNAME
public static final PASchedulerProperties DATASPACE_DEFAULTUSER_URL
public static final PASchedulerProperties DATASPACE_DEFAULTUSER_LOCALPATH
public static final PASchedulerProperties DATASPACE_DEFAULTUSER_HOSTNAME
public static final PASchedulerProperties LOGS_FORWARDING_PROVIDER
public static final PASchedulerProperties SCHEDULER_JOB_LOGS_LOCATION
public static final PASchedulerProperties SCHEDULER_JOB_LOGS_MAX_SIZE
public static final PASchedulerProperties SCHEDULER_JOB_LOGS_PATTERN
public static final PASchedulerProperties SCHEDULER_MEM_MONITORING_FREQ
public static final PASchedulerProperties SCHEDULER_JOB_SUBMISSION_DETAILED_LOGGING
public static final PASchedulerProperties SCHEDULER_HOME
public static final PASchedulerProperties SCHEDULER_REST_URL
public static final PASchedulerProperties CATALOG_REST_URL
public static final PASchedulerProperties RESOURCE_MANAGER_CREDS
public static final PASchedulerProperties RESOURCE_MANAGER_SINGLE_CONNECTION
public static final PASchedulerProperties RESOURCE_MANAGER_CONNECTION_TIMEOUT
public static final PASchedulerProperties SCHEDULER_DB_HIBERNATE_CONFIG
public static final PASchedulerProperties SCHEDULER_DB_HIBERNATE_DROPDB
public static final PASchedulerProperties SCHEDULER_DB_LOAD_JOB_PERIOD
public static final PASchedulerProperties SCHEDULER_DB_TRANSACTION_DAMPING_FACTOR
public static final PASchedulerProperties SCHEDULER_DB_TRANSACTION_MAXIMUM_RETRIES
public static final PASchedulerProperties SCHEDULER_DB_TRANSACTION_SLEEP_DELAY
public static final PASchedulerProperties SCHEDULER_DB_RECOVERY_LOAD_JOBS_BATCH_SIZE
public static final PASchedulerProperties SCHEDULER_DB_FETCH_TASK_RESULTS_BATCH_SIZE
public static final PASchedulerProperties EMAIL_NOTIFICATIONS_CONFIGURATION
public static final PASchedulerProperties EMAIL_NOTIFICATIONS_ENABLED
public static final PASchedulerProperties EMAIL_NOTIFICATIONS_SENDER_ADDRESS
public static final PASchedulerProperties LICENSE_SCHEDULING_POLICY_CONFIGURATION
public static final PASchedulerProperties LICENSE_SCHEDULING_POLICY_DATABASE
public static final PASchedulerProperties SCHEDULER_SYNCHRONIZATION_DATABASE
public static final PASchedulerProperties SCHEDULER_PORTAL_CONFIGURATION
public static final String PA_SCHEDULER_PROPERTIES_FILEPATH
public static final String PA_SCHEDULER_PROPERTIES_RELATIVE_FILEPATH
public static PASchedulerProperties[] values()
for (PASchedulerProperties c : PASchedulerProperties.values()) System.out.println(c);
public static PASchedulerProperties valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic String getKey()
getKey
in interface PACommonProperties
public void updateProperty(String value)
updateProperty
in interface PACommonProperties
value
- the new value to set.public static Map<String,Object> getPropertiesAsHashMap()
public static void loadProperties(String filename)
filename
- the file containing the properties to be loaded.public static void load()
public static void updateProperties(String filename)
filename
- path of file containing some properties to overridepublic String getConfigurationFilePathPropertyName()
PACommonProperties
getConfigurationFilePathPropertyName
in interface PACommonProperties
public String getConfigurationDefaultRelativeFilePath()
PACommonProperties
getConfigurationDefaultRelativeFilePath
in interface PACommonProperties
public void loadPropertiesFromFile(String filename)
PACommonProperties
loadPropertiesFromFile
in interface PACommonProperties
filename
- the file containing the properties to be loaded.public void reloadConfiguration()
PACommonProperties
reloadConfiguration
in interface PACommonProperties
public boolean isSet()
PACommonProperties
isSet
in interface PACommonProperties
public void unSet()
PACommonProperties
unSet
in interface PACommonProperties
public String getCmdLine()
PACommonProperties
getCmdLine
in interface PACommonProperties
public long getValueAsLong()
PACommonProperties
getValueAsLong
in interface PACommonProperties
public int getValueAsInt()
PACommonProperties
getValueAsInt
in interface PACommonProperties
public String getValueAsString()
PACommonProperties
getValueAsString
in interface PACommonProperties
public List<String> getValueAsList(String separator)
PACommonProperties
getValueAsList
in interface PACommonProperties
separator
- the separator to usepublic String getValueAsStringOrNull()
getValueAsStringOrNull
in interface PACommonProperties
public boolean getValueAsBoolean()
Boolean.parseBoolean(String s)
.getValueAsBoolean
in interface PACommonProperties
public PropertyType getType()
getType
in interface PACommonProperties
public String toString()
toString
in class Enum<PASchedulerProperties>
Enum.toString()
public static String getAbsolutePath(String userPath)
It the path is absolute, then it is returned. If the path is relative, then SCHEDULER_HOME
directory is
concatenated in front of the given string.
userPath
- the path to check transform.