public class SystemProperty extends Object
System properties can be specified for application metadata and for request parameters when a request is submitted. Certain system properties are set by Enterprise Scheduler when a request is submitted or at some point in the lifecycle of the request.
Most system properties are common to all job types while some system properties are specific to a particular job type. Unless indicated otherwise, assume that system properties defined by this class are common to all job types.
Enterprise Scheduler reserves "SYS_" (case-insensitive) propery name prefix for Enterprise Scheduler defined properties.
Modifier and Type | Class and Description |
---|---|
static class |
SystemProperty.ExternalJobType
Enum of external job types.
|
Modifier and Type | Field and Description |
---|---|
static String |
ALLOW_MULT_PENDING
Property that specifies whether multiple pending requests for the
same JobDefinition shall be allowed.
|
static String |
APPLICATION
Property that specifies the name of the J2EE application that is
used for request processing.
|
static String |
ASYNC_REQUEST_TIMEOUT
Property that specifies the time, in minutes, that the processor will
wait for an asynchronous after it has begun execution.
|
static String |
BIZ_ERROR_EXIT_CODE
Property that specifies the process exit code for a Process job
request that denotes an execution business error.
|
static String |
CLASS_NAME
Property that specifies the Java executable for a Java job request.
|
static String |
CMDLINE
Property that specifies the command line used to invoke an
external program for a Process job request.
|
static String |
CMDLINE_PREFIX
Prefix for extended OS-specific command line system properties.
|
static String |
CMDLINE_UNIX
Indicates the full command line for executing a Process type request
executable on a Unix or Unix-like operating system.
|
static String |
CMDLINE_WINDOWS
Indicates the full command line for executing a Process type request
executable on a Windows operating system.
|
static String |
DEFAULT_EFFECTIVE_APPLICATION |
static String |
EFFECTIVE_APPLICATION
Property that specifies the name of the J2EE application that will
be the effective application for the request.
|
static String |
EJB_OPERATION_NAME
Property that specifies the operation name of the EJB.
|
static String |
ENVIRONMENT_VARIABLES
Property that specifies the environment variables to be set for
the spawned process of a Process job request.
|
static String |
ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME
Property that specifies the mapped name of AsyncRequest EJB
of ESS bound to JNDI of ESS server.
|
static String |
ESS_JNDI_CSF_KEY_NAME
Name that denotes CSF KEY name of Jndi provider of the
underlying ESS server.
|
static String |
ESS_JNDI_PROVIDER_URL_NAME
Name that denotes property of the Jndi provider URL of the
underlying ESS server.
|
static String |
ESS_METADATA_JNDI_MAPPED_NAME
Property that specifies the mapped name of MetadataService EJB
of ESS bound to JNDI of ESS server.
|
static String |
ESS_RUNTIME_JNDI_MAPPED_NAME
Property that specifies the mapped name of RuntimeService EJB
of ESS bound to JNDI of ESS server.
|
static String |
EXECUTABLE_DIR_PREFIX
Prefix for extended OS-specific executable directory system properties.
|
static String |
EXECUTABLE_DIR_UNIX
Property that indicates the directory where the executable resides
for a Process type request on a Unix or Unix-like operating system.
|
static String |
EXECUTABLE_DIR_WINDOWS
Property that indicates the directory where the executable resides
for a Process type request on a Windows operating system.
|
static String |
EXECUTABLE_NAME
The name of the executable for a Process type request.
|
static String |
EXECUTABLE_SUFFIX_UNIX
Property that indicates the file extension of the executable
for a Process type request if executed on a generic Unix or
Unix-like operating system.
|
static String |
EXECUTABLE_SUFFIX_WINDOWS
Property that indicates the file extension of the executable
for a Process type request if executed on a Windows operating system.
|
static String |
EXECUTE_AUTO_EXPORT
Property that specifies whether the previously imported output content
for the request shall be automatically exported to the request
output directory before the job execute stage runs.
|
static String |
EXECUTE_PAST
Property that specifies whether instances of a repeating request
with an execution time in the past should be generated.
|
static String |
EXTENSION_LISTENER
Property that specifies the extension event listener class associated
with the request.
|
static String |
EXTERNAL_ID
Property that specifies an identifier for an external portion of an
Enterprise Scheduler asynchronous Java job.
|
static String |
EXTERNAL_JOB_TYPE
Property that specifies an indicator of the type of the remote
component of the job.
|
static String |
FUSION_JOB
Property that indicates whether the job associated with this request
is a Fusion job.
|
static String |
GROUP_NAME
Property that specifies the name of the ESS configuration group
to which this request is bound.
|
static String |
INPUT_LIST
Property that specifies input to a request.
|
static String |
INPUT_WORK_DIR
Property that specifies the work directory used during request
processing for input files.
|
static String |
INVOKE_MESSAGE
Property that holds the xml message payload used as the input
for invoking the remote webservice.
|
static String |
JNDI_CSF_KEY
Property that pointing to the CSF alias that is mapped to the username
and password in keystore.
|
static String |
JNDI_MAPPED_NAME
Property that specifies the mapped name of an EJB that is
bound to JNDI of a local/remote server.
|
static String |
JNDI_PROVIDER_URL
Property that specifies the Url of Jndi provider pertaining
to a remote server.
|
static String |
LISTENER
Property that specifies the event listener class associated with
the request.
|
static String |
LOCALE
Property that specifies the locale associated with the request.
|
static String |
LOG_WORK_DIR
Property that specifies the work directory used during request
processing for log files.
|
static String |
LOGICAL_CLUSTER_NAME
Property that specifies the name of a logical cluster.
|
static String |
NATIVE_HOSTING_APP_LOGICAL_NAME
Logical application name for the ESS native hosting app.
|
static String |
NATIVE_HOSTING_APP_STRIPE_NAME
Application stripe name for for the ESS native hosting app.
|
static String |
OUTPUT_LIST
Property that specifies output from a request.
|
static String |
OUTPUT_LIST_DELIMITER
Delimiter to be used when building an
OUTPUT_LIST value. |
static String |
OUTPUT_WORK_DIR
Property that specifies the work directory used during request
processing for output files.
|
static String |
POST_PROCESS
Property that specifies the post-process callout handler class.
|
static String |
PRE_PROCESS
Property that specifies the pre-process callout handler class.
|
static String |
PRIORITY
Property that specifies the request processing priority.
|
static String |
PROCEDURE_NAME
Property that specifies the name of the PLSQL stored procedure
to be called for a SQL job request.
|
static String |
PROCESS_ARGUMENTS
Property that indicates the arguments passed to the executable
of a Process type spawned process.
|
static String |
PRODUCT
Property that specifies the product within the application that
submitted the request.
|
static String |
REDIRECTED_OUTPUT_FILE
Property that specifies the file where standard output and
error streams are redirected for a Process job request.
|
static String |
REPROCESS_DELAY
Property that specifies the callout handler processing delay time.
|
static String |
REQUEST_CATEGORY
Property that specifies an application-specific label for a request.
|
static String |
REQUEST_EFFECTIVE_ENCODING
Property that stores the effective encoding associated with a
spawned job request.
|
static String |
REQUEST_EXPIRATION
Property that specifies the expiration time for a request.
|
static String |
REQUEST_LOG_LEVEL
Property that specifies the log level for request logging.
|
static String |
REQUESTED_PROCESSOR
Property that specifies the request processor node on which the
request should be processed.
|
static String |
RESOLVED_CMDLINE
Property that specifies the command line used for a Process type
job request.
|
static String |
RETRIES
Property that specifies the retry limit for a failed request.
|
static String |
RUNAS_APPLICATIONID
Property that specifies a job runas ApplicaitonId.
|
static String |
SELECT_STATE
Property that specifies whether the result state of a JobSet step
should be included when determining the state of the JobSet.
|
static String |
SQL_JOB_CLASS
Property that specifies an Oracle Scheduler job class to be assigned
to the Oracle Scheduler job used to execute an SQL job request.
|
static String |
SUBMITTING_APPLICATION
Property that specifies the name of the J2EE application for the
submitted (absolute parent) request.
|
static String |
SUBSTITUTION_HANDLERS
Deprecated.
Property that specifies a substitution handler class or list
of classes that should be used for parameter substitution. The
property value can specify a single Java class name, or it specify
a comma-seperated set of Java class names.
The Java class must implement the
Enterprise Scheduler will use this property when executing a
The property datatype is
|
static String |
SUCCESS_EXIT_CODE
Property that specifies the process exit code for a Process job
request that denotes an execution success.
|
static String |
SUPPORT_OUTPUT_FILES
Property that specifies whether the request will create temporary
or output files.
|
static String |
SUPPORT_OUTPUT_FILES_NONE
Mode for
SUPPORT_OUTPUT_FILES property
that indicates no request directories shall be created. |
static String |
SUPPORT_OUTPUT_FILES_OUTPUT
Mode for
SUPPORT_OUTPUT_FILES property
that indicates both the request work and output directories shall be
created. |
static String |
SUPPORT_OUTPUT_FILES_WORK
Mode for
SUPPORT_OUTPUT_FILES property
that indicates only the work directory shall be created. |
static String |
SYS_PROPERTY_PREFIX
Property name prefix for Enterprise Scheduler system properties.
|
static String |
SYSEXT_PROPERTY_PREFIX |
static String |
UPLOAD_CONTENT_TO_REPOSITORY
Property that indicates whether to upload request log and output files
to a separate repository, such as Universal Content Management (UCM),
from the internal repository when the request execution completes.
|
static String |
UPLOAD_CONTENT_TO_REPOSITORY_COPY
Mode for
UPLOAD_CONTENT_TO_REPOSITORY
property that indicates copying the content from the content store
to the repository, while retaining the content in the content store. |
static String |
USE_ALTERNATE_ENV
Property that indicates whether to use an alternative environment
from a callout rather than the normal application environment.
|
static String |
USE_EXTENDED_SETUP
Property that indicates whether to initiate capabilities,
like
ApplSessions , prior to invoking the job-related
code such as the job executable or preprocess handler,
postprocess handler. |
static String |
USER_FILE_DIR
Property that specifies a base directory in the file system where
files, such as input and output files, may be stored for use by
the request executable.
|
static String |
USER_FILE_DIR_SHARED
Property that specifies whether the request's USER_FILE_DIR
(configured RequestFileDir) directory is shared.
|
static String |
USER_NAME
Property that specifies the name of the user who submitted
the request.
|
static String |
WARNING_EXIT_CODE
Property that specifies the process exit code for a Process job
request that denotes an execution warning.
|
static String |
WORK_DIR_ROOT
Property that specifies the working directory for the spawned
process of a Process job request.
|
static String |
WS_CANCEL_MESSAGE
Property that holds the xml message payload used as the input
for invoking Cancel on remote webservice.
|
static String |
WS_CANCEL_OPERATION_NAME
Property that specifies the wsdl Operation name for webservice
cancel operation.
|
static String |
WS_ENDPOINT_BASE_URL
Property that specifies a base URL that can be used in conjunction
with
WS_ENDPOINT_URL to provide a full URL
for the web service endpoint. |
static String |
WS_ENDPOINT_URL
Property that specifies the relative URL for webservice Endpoint.
|
static String |
WS_OPERATION_NAME
Property that specifies the wsdl Operation name for webservice
operation.
|
static String |
WS_PORT_NAME
Property that specifies the wsdl Port name for webservice operation.
|
static String |
WS_SERVICE_NAME
Property that specifies the wsdl Service name for webservice operation.
|
static String |
WS_TARGET_NS
Property that specifies the Target Namespace for the webservice.
|
static String |
WS_WSDL_BASE_URL
Property that specifies a base URL that can be used in conjunction
with
WS_WSDL_URL property to provide a full URL
for the web service wdl. |
static String |
WS_WSDL_URL
Property that specifies the relative URL for webservice WSDL.
|
Constructor and Description |
---|
SystemProperty() |
Modifier and Type | Method and Description |
---|---|
static Set |
getCorePropNames()
Get the core system properties.
|
static Set |
getExtendedPropNames()
Get the extended system properties.
|
static Set |
getInternalOnlyProps()
Get the set of system properties that should not be set except
by ESS internals.
|
static Set |
getMetadataOnlyProps()
Get the set of system properties that can be set in meta-data
but should not be set at submission.
|
static Enumeration |
getNames()
Get the names of the system properties.
|
static Set |
getReadOnlySysProps()
Get the set of system properties that cannot be updated after
submission through normal channels.
|
static ParameterInfo |
getSysPropInfo(String name)
Get the information for the system property identified by
the given name.
|
static boolean |
isCoreSystemProp(String name)
Indicates whether the given system property is a core system property.
|
static boolean |
isInternalOnly(String name)
Determine if the given system property that should not be set except
by ESS internals.
|
static boolean |
isMetadataOnly(String name)
Indicates if the given system property can be set in metadata but
not at submission.
|
public static final String DEFAULT_EFFECTIVE_APPLICATION
public static final String SYS_PROPERTY_PREFIX
public static final String SYSEXT_PROPERTY_PREFIX
public static final String OUTPUT_LIST_DELIMITER
OUTPUT_LIST
value.
This constant does not represent a system property name. It is
simply the delimiter used to build the value for the
SystemProperty.OUTPUT_LIST
property.
public static final String CMDLINE_PREFIX
public static final String EXECUTABLE_DIR_PREFIX
public static final String UPLOAD_CONTENT_TO_REPOSITORY_COPY
UPLOAD_CONTENT_TO_REPOSITORY
property that indicates copying the content from the content store
to the repository, while retaining the content in the content store.public static final String SUPPORT_OUTPUT_FILES_NONE
SUPPORT_OUTPUT_FILES
property
that indicates no request directories shall be created. This is
appropriate for a job that does not create any files in the file
system, whether temporary or output.public static final String SUPPORT_OUTPUT_FILES_WORK
SUPPORT_OUTPUT_FILES
property
that indicates only the work directory shall be created. This is
appropriate for a job that creates temporary files and not output files.public static final String SUPPORT_OUTPUT_FILES_OUTPUT
SUPPORT_OUTPUT_FILES
property
that indicates both the request work and output directories shall be
created. This is appropriate for a job that creates output files and
may or may not create temporary files.public static final String APPLICATION
The property datatype is
STRING
.
public static final String EFFECTIVE_APPLICATION
This property is valid only for metadata of a job or job set definition.
It can be used to specify the J2EE application that should be used
for a request for that definition. At runtime request validation,
the value of this property is used to set the SystemProperty.APPLICATION
system property for that request if it is present in the definition
metadata.
If this property is set in the metadata for a job set, then at runtime,
this value is used to set the APPLICATION
property of that
JobSet request and all step requests of that job set, unless the
EFFECTIVE_APPLICATION
property is set in the definiton for
a given step in which case the value from the definition for that
step has precedence.
The property datatype is
STRING
.
public static final String SUBMITTING_APPLICATION
The property datatype is
STRING
.
public static final String PRODUCT
The property datatype is
STRING
.
public static final String USER_NAME
The property datatype is
STRING
.
public static final String REQUEST_CATEGORY
The property datatype is
STRING
.
public static final String GROUP_NAME
The property datatype is
STRING
.
public static final String CLASS_NAME
Executable
interface.
This property is required for a
Java
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String PROCEDURE_NAME
schema.name
format.
The property is required for a
SQL
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String SQL_JOB_CLASS
Enterprise Scheduler uses an Oracle Scheduler job to execute the PLSQL stored procedure for a SQL job request. An Oracle Scheduler job class can be associated with the Scheduler job when that job needs to have affinity to a database service or is to be associated with an Oracle Database resource consumer group. The Oracle Scheduler job owner must have EXECUTE privilege on the Oracle Scheduler job class in order to successfully create a Scheduler job using that job class.
If this property is not specified,a default Oracle Scheduler job class is used for the Oracle Scheduler job. That job class is associated with the default resource consumer group. It will belong to the default service, which means it will have no service affinity and, in an Oracle RAC enviroment, any one of the database instances within the cluster might run the Scheduler job. No additional privilege grant is needed for an Enterprise Scheduler SQL request to use that default job class.
This property is optional for a
SQL
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String CMDLINE
NOTE: This property is not the standard way to set the command line.
See SystemProperty.EXECUTABLE_DIR_UNIX
, SystemProperty.EXECUTABLE_DIR_WINDOWS
,
SystemProperty.EXECUTABLE_SUFFIX_UNIX
, SystemProperty.EXECUTABLE_SUFFIX_WINDOWS
.
This property is required for a
Process
job type.
It is not used for other job types.
Enterprise Scheduler will perform substitution when evaluating the value of this property using the default substitution handlers.
The property datatype is
STRING
.
public static final String INPUT_LIST
Enterprise Scheduler imposes no format on the value of this property.
The property datatype is
STRING
.
public static final String OUTPUT_LIST
OUTPUT_LIST
of the
last step. The output of a parallel JobSet is the concatenation of
the OUTPUT_LIST
of all the steps, in no guaranteed order,
with SystemProperty.OUTPUT_LIST_DELIMITER
as a separator.
The property datatype is
STRING
.
public static final String LOCALE
The property datatype is
STRING
.
public static final String PRIORITY
The property datatype is
INTEGER
.
public static final String RETRIES
The property datatype is
INTEGER
.
public static final String PRE_PROCESS
PreProcessHandler
interface.
The property datatype is
STRING
.
public static final String POST_PROCESS
PostProcessHandler
interface.
The property datatype is
STRING
.
public static final String REPROCESS_DELAY
public static final String LISTENER
EventListener
interface.
The property datatype is
STRING
.
public static final String EXTENSION_LISTENER
EventListener
interface.
The property datatype is
STRING
.
public static final String REQUEST_EXPIRATION
The property datatype is
INTEGER
.
public static final String ENVIRONMENT_VARIABLES
name=value
) representing the environment variables to be set.
NOTE: This property is not the standard way to set environment variables. It is usually done through the application's ESS configuration file.
This property is optional for a
Process
job type.
It is not used for other job types.
Enterprise Scheduler will perform substitution when evaluating the value of this property using the default substitution handlers.
The property datatype is
STRING
.
public static final String WORK_DIR_ROOT
This property is optional for a
Process
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String LOG_WORK_DIR
The property datatype is
STRING
.
public static final String INPUT_WORK_DIR
The property datatype is
STRING
.
public static final String OUTPUT_WORK_DIR
The property datatype is
STRING
.
public static final String REDIRECTED_OUTPUT_FILE
This property is optional for a
Process
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String REQUESTED_PROCESSOR
If this property is specified for a request, the request processor's
WorkAssignment
s (specialization) must allow the execution
of such requests, otherwise the request will never be executed.
If the specified node is not running, the request will remain in
WAIT
state and will not be executed until the node is restarted.
The property datatype is
STRING
.
public static final String SUCCESS_EXIT_CODE
This property is optional for a
Process
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String WARNING_EXIT_CODE
This property is optional for a
Process
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String BIZ_ERROR_EXIT_CODE
This property is optional for a
Process
job type.
It is not used for other job types.
The property datatype is
STRING
.
public static final String EXECUTE_PAST
Note that a null requested start time defaults to the current time.
To cause past instances to be generated, you must set this property
to true
and specify the requested start time as the initial
time from which instances should be generated.
Valid values for this property are:
true
All instances specified by a schedule that are
within the range specified by requested start time to requested
end time will be generated regardless of the time of generation.
false
Instances with a scheduled execution time in the
past (that is, before the time of generation) will not be generated.
If this property is not specified, system default used is true
.
The property datatype is
BOOLEAN
.
public static final String USER_FILE_DIR
Enterprise Scheduler supports a configuration parameter that
specifies a file directory where requests may store files.
At request submission, a USER_FILE_DIR
property will
automatically be added for the request if the configuration
parameter is currently set and USER_FILE_DIR
property
was not specified for the request. If the property is added, it
will be initialized to the value of the configuration parameter.
The property will not be added if the configuration parameter is
not set at time of request submission.
The property datatype is
STRING
.
public static final String ALLOW_MULT_PENDING
Valid values for this property are:
true
Multiple pending requests are allowed.
false
Multiple pending requests are not allowed.
If this property is not specified, system default used is true
.
The property datatype is
BOOLEAN
.
public static final String SELECT_STATE
Valid values for this property are:
true
Include the step's state as part of the JobSet state.
false
Do not include the step's state as part of the
JobSet state.
If this property is not specified, system default used is true
.
The property datatype is
BOOLEAN
.
@Deprecated public static final String SUBSTITUTION_HANDLERS
The Java class must implement the
SubstitutionHandler
interface.
Enterprise Scheduler will use this property when executing a
Process
job type to
provide substition support for the SystemProperty.CMDLINE
and
SystemProperty.ENVIRONMENT_VARIABLES
system properties.
The property datatype is
STRING
.
public static final String RUNAS_APPLICATIONID
public static final String ASYNC_REQUEST_TIMEOUT
If this property is not specified, the system default value used is 0L.
The property datatype is
LONG
.
public static final String EXTERNAL_ID
This property should be set by the job implementation of asynchronous Java jobs when the identifier is known. It is never set by the Enterprise Scheduler.
The property datatype is
STRING
.
public static final String REQUEST_LOG_LEVEL
Valid values for log level are the String representations of levels
defined in java.util.logging.Level
obtained via
Level.getName()
.
The default log level is "INFO".
The property datatype is
STRING
.
public static final String EXECUTE_AUTO_EXPORT
This property is applicable to the execute stage for spawned, synchronous Java, and asynchronous Java job types. It does not apply to the update stage of asynchronous Java job types and does not apply to PL/SQL job types.
Valid values for this property are:
true
All previously imported output content will be
exported to files in the request's output directory before the
job execute stage.
false
No output content is automatically exported.
The job may choose to manually export output content.
If this property is not specified, system default used is false
.
The property datatype is
BOOLEAN
.
public static final String SUPPORT_OUTPUT_FILES
The request can always use the API to create output content directly in the content store.
Valid values are:
SystemProperty.SUPPORT_OUTPUT_FILES_NONE
SystemProperty.SUPPORT_OUTPUT_FILES_WORK
SystemProperty.SUPPORT_OUTPUT_FILES_OUTPUT
If this property is not specified, no directories will be created.
The property datatype is
STRING
.
public static final String CMDLINE_UNIX
Typically, this property is specified in the job type and the executable name, path, and arguments are used to indicate values to be substituted at runtime.
See EXECUTABLE_NAME
,
EXECUTABLE_DIR_UNIX
,
EXECUTABLE_SUFFIX_UNIX
,
PROCESS_ARGUMENTS
.
The property datatype is
STRING
.
public static final String CMDLINE_WINDOWS
Typically, this property is specified in the job type and the executable name, path, and arguments are used to indicate values to be substituted at runtime.
See EXECUTABLE_NAME
,
EXECUTABLE_DIR_WINDOWS
,
EXECUTABLE_SUFFIX_WINDOWS
,
PROCESS_ARGUMENTS
.
The property datatype is
STRING
.
public static final String EXECUTABLE_NAME
See EXECUTABLE_DIR_UNIX
and
#EXECUTABLE_DIR_WINDOWS
.
The property datatype is
STRING
.
public static final String EXECUTABLE_DIR_UNIX
The property datatype is
STRING
.
public static final String EXECUTABLE_DIR_WINDOWS
The property datatype is
STRING
.
public static final String EXECUTABLE_SUFFIX_UNIX
The default is no extension.
The property datatype is
STRING
.
public static final String EXECUTABLE_SUFFIX_WINDOWS
The default is no extension.
The property datatype is
STRING
.
public static final String PROCESS_ARGUMENTS
The property datatype is
STRING
.
public static final String RESOLVED_CMDLINE
The property datatype is
STRING
.
public static final String FUSION_JOB
Valid values for this property are:
true
the job is a Fusion job
false
the job is not a Fusion job
If this property is not specified, default value used is false
.
The property datatype is
BOOLEAN
.
public static final String USER_FILE_DIR_SHARED
This property is valid for a request in standard or extended request mode.
Valid values for this property are:
true
USER_FILE_DIR is a shared directory.
false
USER_FILE_DIR is a local directory.
If this property is not specified, system default used is false
.
The property datatype is
BOOLEAN
.
public static final String UPLOAD_CONTENT_TO_REPOSITORY
If this property is not specified, content will not be uploaded.
Valid values are:
#UPLOAD_CONTENT_TO_REPOSITORY_COPY
The property datatype is
STRING
.
public static final String USE_EXTENDED_SETUP
ApplSessions
, prior to invoking the job-related
code such as the job executable or preprocess handler,
postprocess handler.
Extended functionality will be invoked only in environments where it is available.
If this property is not specified, no extended functionality will be set up prior to job execution.
The property datatype is
BOOLEAN
.
public static final String USE_ALTERNATE_ENV
If this property is not specified, the normal application environment will be used.
The property datatype is
BOOLEAN
.
public static final String JNDI_PROVIDER_URL
If this property is not specified, the job will be executed in local server.
The property datatype is
STRING
.
public static final String JNDI_MAPPED_NAME
The property datatype is
STRING
.
public static final String EJB_OPERATION_NAME
The property datatype is
STRING
.
public static final String JNDI_CSF_KEY
This property is needed only if the JNDI tree is secured.
The property datatype is
STRING
.
public static final String INVOKE_MESSAGE
This property is a pass through parameter for EJB jobtype
The property datatype is
STRING
.
public static final String WS_WSDL_URL
The base URL is given by the WS_WSDL_BASE_URL
property.
The property datatype is
STRING
.
public static final String WS_WSDL_BASE_URL
WS_WSDL_URL
property to provide a full URL
for the web service wdl.
The property is usually used in conjunction with
LOGICAL_CLUSTER_NAME
. It is meant
to be a generic base URL that is common for all webservice wsdls
in the cluster.
This property is optional. If it is not specified, equivalent
information may be retrieved from the information associated with the
LOGICAL_CLUSTER_NAME
property of the
request if it is configured in the hosting application's configuration.
The property datatype is
STRING
.
public static final String WS_TARGET_NS
The property datatype is
STRING
.
public static final String WS_ENDPOINT_URL
The base URL is given by WS_ENDPOINT_BASE_URL
.
The property datatype is
STRING
.
public static final String WS_ENDPOINT_BASE_URL
WS_ENDPOINT_URL
to provide a full URL
for the web service endpoint.
The property is usually used in conjunction with
LOGICAL_CLUSTER_NAME
. It is meant to be
a generic base URL that is common for all webservice endpoints in
the cluster.
This property is optional. If it is not specified, equivalent
information may be retrieved from the information associated with the
LOGICAL_CLUSTER_NAME
property of the
request if it is configured in the hosting application's configuration.
The property datatype is
STRING
.
public static final String WS_SERVICE_NAME
The property datatype is
STRING
.
public static final String WS_PORT_NAME
The property datatype is
STRING
.
public static final String WS_OPERATION_NAME
The property datatype is
STRING
.
public static final String WS_CANCEL_OPERATION_NAME
The property datatype is
STRING
.
public static final String WS_CANCEL_MESSAGE
The property datatype is
STRING
.
public static final String ESS_RUNTIME_JNDI_MAPPED_NAME
The property datatype is
STRING
.
public static final String ESS_METADATA_JNDI_MAPPED_NAME
The property datatype is
STRING
.
public static final String ESS_ASYNC_REQUEST_JNDI_MAPPED_NAME
The property datatype is
STRING
.
public static final String ESS_JNDI_CSF_KEY_NAME
The property datatype is
STRING
.
public static final String LOGICAL_CLUSTER_NAME
If the property is not specified, no logical cluster will be associated with the request.
The property datatype is
STRING
.
public static final String EXTERNAL_JOB_TYPE
SystemProperty.ExternalJobType
.
The supported values are "SOA", "OSB", "ADFBC".
This property is optional. If it is not specified, Enterprise Scheduler will not associate the request with an external job type, regardless of how the job is actually implemented.
The property datatype is
STRING
.
public static final String REQUEST_EFFECTIVE_ENCODING
SpawnLauncher determines the Locale setting for a spawned job request
in the following precedence order:
a. LC_ALL/LANG specified in environment properties
(SystemProperty.ENVIRONMENT_VARIABLES
) for the request
b. LC_ALL/LANG specified in HostingApp ess-config.xml
c. Weblogic server LC_ALL/LANG.
The effective encoding is computed before the process is spawned and is stored in this property. This is later used to determine the encoding to use for the request log and output.
The property datatype is
STRING
.
public static final String ESS_JNDI_PROVIDER_URL_NAME
public static final String NATIVE_HOSTING_APP_LOGICAL_NAME
public static final String NATIVE_HOSTING_APP_STRIPE_NAME
public static Enumeration getNames()
Enumeration<String>
of the names of the system
properties.public static Set getCorePropNames()
The distinction between core and extended system properties is internal to ESS, and relates to when and how frequently they are used, and may indicate how they will be stored.
Set<String>
of the names of the core system properties.public static Set getExtendedPropNames()
The distinction between core and extended system properties is internal to ESS, and relates to when and how frequently they are used, and may indicate how they will be stored.
Set<String>
of the names of the extended system
properties.public static boolean isCoreSystemProp(String name)
name
- the name of the system propertytrue
if it is a core system property, false
otherwise.public static ParameterInfo getSysPropInfo(String name)
name
- the name of the system property.
If null
, this method returns null
.null
if no such system property exists.public static Set getReadOnlySysProps()
Set<String>
of system properties that cannot be
updated after submission.public static Set getInternalOnlyProps()
Set<String>
of system properties that should not be
set except by ESS internals.public static Set getMetadataOnlyProps()
Set<String>
of system properties that can be
set in metadata but should not be set at submission.public static boolean isInternalOnly(String name)
true
if not should not be set, false
otherwise.public static boolean isMetadataOnly(String name)
name
- the name of the system propertytrue
if this system property can be set when
defining metadata, but should not be set in RequestParameters
at request submission. Returns false
otherwise.