|
| |
|
| java.lang.Object
 org.obe.util.CommonConfig
org.obe.spi.service.ServerConfig
| ServerConfig | | final public class ServerConfig extends CommonConfig (Code) | | Provides access to OBE server configuration information. OBE is configured
by several XML and properties files, which can either be located in the OBE
configuration directory or in the META-INF/services directory in
obeconfig.jar. Resources in the latter location are accessed via this
class's ClassLoader. The OBE configuration directory can be specified by the
system property "obe.config.dir", and it defaults to the current
directory. Loose files take precedence over resources in obeconfig.jar.
The obe.properties file contains the main OBE configuration,
and the ServiceManager.properties file contains the OBE
ServiceManager configuration.
author:
Adrian Price |
| Method Summary | |
| public static int | getAsyncThreadpoolSize()
Returns the size of the thread pool used to service asynchronous
execution requests. | | public static int | getDirectoryPollInterval()
Returns the polling interval for the
${obe.config.dir}/processes and
${obe.config.dir}/events directories. | | public static String | getDomain()
Returns the server's management domain. | | public static String | getHostAddress()
Returns the local host's IP address. | | public static String | getHostName()
Returns the local host's DNS host name. | | public static InetAddress | getLocalHost()
Returns the local host's InetAddress, if known. | | public static Session | getMailSession()
Returns the default mail session. | | public static int | getMaximumTemporalEventTardiness()
Returns the maximum acceptable delay for processing a non-recoverable
temporal event. | | public static String | getNodeId()
Returns the server's node ID. | | public static String | getScriptType()
Returns the default script type to use if one is not specified in XPDL. | | public static boolean | isAuditNonTransactional()
Returns whether auditing should be performed non-transactionally. | | public static boolean | isVerbose()
Returns whether debug output should be verbose. | | public static boolean | reuseWorkItems()
Returns whether work items should be re-used. | | public static boolean | supportsKeyBasedEventSubscriptions()
Returns whether the event manager should accept key-based event
subscriptions. | | public static boolean | useEventAPI()
Returns whether to inject application events via the
WMLocalClient local client API . | | public static boolean | useInitServlet()
Returns whether to defer initialization to the J2EEInitServlet. |
| getAsyncThreadpoolSize | | public static int getAsyncThreadpoolSize()(Code) | | Returns the size of the thread pool used to service asynchronous
execution requests.
The setting reflects the value of the configuration property
obe.async.threadpool.size.
Async thread pool size, defaulting to 20.
See Also: ServerConfig.ASYNC_THREADPOOL_SIZE_PROP |
| getDirectoryPollInterval | | public static int getDirectoryPollInterval()(Code) | | Returns the polling interval for the
${obe.config.dir}/processes and
${obe.config.dir}/events directories. Only used by the
BasicProcessRepository and BasicApplicationEventBroker.
The setting reflects the value of the configuration property
obe.directory.poll.interval.
Polling interval in milliseconds, defaulting to 5000(5 seconds).
See Also: ServerConfig.DIRECTORY_POLL_INTERVAL_PROP |
| getDomain | | public static String getDomain()(Code) | | Returns the server's management domain. Currently, this returns the
hard-coded string "OBE". In a future release,
this will be changed to return the name of the management domain to which
the server belongs.
The setting reflects the string value of the configuration property
obe.domain.
The management domain name, defaulting to "OBE".
See Also: ServerConfig.DOMAIN_PROP |
| getHostAddress | | public static String getHostAddress()(Code) | | Returns the local host's IP address.
The local host address. |
| getHostName | | public static String getHostName()(Code) | | Returns the local host's DNS host name.
The DNS host name. |
| getLocalHost | | public static InetAddress getLocalHost()(Code) | | Returns the local host's InetAddress, if known.
The local host. |
| getMailSession | | public static Session getMailSession() throws OBEException(Code) | | Returns the default mail session.
Mail session. |
| getMaximumTemporalEventTardiness | | public static int getMaximumTemporalEventTardiness()(Code) | | Returns the maximum acceptable delay for processing a non-recoverable
temporal event. Non-recoverable temporal events older than this are
discarded unprocessed.
The setting reflects the value of the configuration property
obe.events.max.tardiness.
Maximum temporal event processing delay, defaulting to30000 (5 minutes).
See Also: ServerConfig.EVENT_MAX_TARDINESS_PROP |
| getNodeId | | public static String getNodeId()(Code) | | Returns the server's node ID. Currently, this returns the server's
DNS host name. In a future release, this will be changed to return a
node ID that is unique within the management domain to which the server
belongs.
The setting reflects the string value of the configuration property
obe.node.
The server's node ID, defaulting to the primary DNS host name.
See Also: ServerConfig.NODE_PROP |
| getScriptType | | public static String getScriptType()(Code) | | Returns the default script type to use if one is not specified in XPDL.
The setting reflects the boolean value of the configuration property
obe.script.
Script type, defaulting to "text/x-xpath".
See Also: ServerConfig.SCRIPT_PROP |
| isAuditNonTransactional | | public static boolean isAuditNonTransactional()(Code) | | Returns whether auditing should be performed non-transactionally. If
auditing is transactional, audit entries are enlisted in the transaction
and will be lost in the event of a rollback. Otherwise, audit entries
will be always logged regardless of the outcome of the transaction to
which they relate.
N.B. Non-transactional auditing is very much more expensive than
transactional auditing, and should only be used if absolutely
necessary. In addition, interpreting the audit log is less
straightforward, because the transactional context must be taken into
account to determine whether an audit entry relates to a committed change
or one which was rolled back. At the time of writing, non-transactional
auditing support is incomplete, in that the transaction ID is not
currently included in the logged information.
The setting reflects the value of the configuration property
obe.audit.nontransactional:
| Type | Default | Purpose |
|---|
| boolean | false |
The property name that specifies whether to log audit entries
non-transactionally.
|
true for non-transactional auditing.
See Also: ServerConfig.AUDIT_NON_TXN_PROP |
| isVerbose | | public static boolean isVerbose()(Code) | | Returns whether debug output should be verbose.
The setting reflects the boolean value of the configuration property
obe.debug.verbose.
true if verbose debugging is enabled, defaulting tofalse.
See Also: ServerConfig.VERBOSE_PROP |
| reuseWorkItems | | public static boolean reuseWorkItems()(Code) | | Returns whether work items should be re-used.
The setting reflects the boolean value of the configuration property
obe.reuse.workitems.
true if work item re-use is enabled.
See Also: ServerConfig.REUSE_WORKITEMS_PROP |
| supportsKeyBasedEventSubscriptions | | public static boolean supportsKeyBasedEventSubscriptions()(Code) | | Returns whether the event manager should accept key-based event
subscriptions.
The setting reflects the value of the configuration property
obe.events.key.based.subscriptions.
true to accept key-based subscriptions,false to reject, defaulting to true.
See Also: ServerConfig.EVENT_KEY_BASED_SUBSCRIPTIONS_PROP |
| useEventAPI | | public static boolean useEventAPI()(Code) | | Returns whether to inject application events via the
WMLocalClient local client API . The engine creates
an
ApplicationEventListener application eventlistener , with which it subscribes for workflow-relevant application
events. Injecting application events via the API allows them to be
handled in a transactional context under an authenticated identity if the
ApplicationEventBroker implementation does not provide these
characteristics.
The setting reflects the boolean value of the configuration property
obe.events.use.api.
true if events are to be injected via the API,false for direct injection into the workflow engine.
See Also: ServerConfig.USE_EVENT_API_PROP |
| useInitServlet | | public static boolean useInitServlet()(Code) | | Returns whether to defer initialization to the J2EEInitServlet.
true to defer initialization, false toinitialize immediately.
See Also: ServerConfig.USE_INIT_SERVLET_PROP |
|
|
|