|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Engine
The Flux engine that executes flow charts and contains a variety of job scheduling, automated workflow, managed file transfer, and workload automation functionality.
Method Summary | |
---|---|
long |
clear()
Removes all flow charts, users, roles, logs, audit trail entries, and, in general, all data associated with the cluster. |
void |
clearAuditTrail()
Removes all audit trail entries. |
void |
clearLogs()
Removes all log entries from the database. |
void |
clearRunHistory()
Removes all run history entries. |
void |
clearRunHistory(java.lang.String namespace)
Removes all run history entries for the specified namespace. |
long |
clearSignal(java.lang.String namespace,
java.lang.String signal)
Clears the specified signal from all flow charts specified by a hierarchical flow chart namespace expression. |
long |
clearSignals(java.lang.String namespace)
Clears all signals from all flow charts specified by a hierarchical flow chart namespace expression. |
void |
dispose()
Stops the engine, disposes all engine resources, and finally shuts down the engine. |
long |
expedite(java.lang.String namespace)
Forces the specified flow charts to be executed as soon as possible. |
java.util.List<java.lang.String> |
findBusinessIntervalUsages(java.lang.String businessIntervalNamespace)
Finds flow charts in the engine that reference the specified business interval. |
ForecastIterator |
forecast(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns an ordered result of flow charts, based on the next scheduled firing time of each flow chart, given all flow charts in the specified flow chart namespace and within the specified time range. |
FlowChartIterator |
get()
Returns all flow charts ordered by flow chart name. |
FlowChart |
get(java.lang.String flowChartName)
Returns a flow chart whose name matches the specified flow chart name. |
ActionHistoryIterator |
getActionHistory(java.lang.String flowChartName,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns historical execution timestamps which occurred within the lower and upper date boundaries for all actions and triggers in a flow chart. |
ActionHistoryIterator |
getActionHistory(java.lang.String flowChartName,
java.util.Date lowerBound,
java.util.Date upperBound,
java.lang.String actionType)
Returns historical execution timestamps which occurred within the lower and upper date boundaries for an action or trigger type in a flow chart. |
ActionHistoryIterator |
getActionHistory(java.lang.String flowChartName,
java.lang.String actionName)
Returns historical timestamps for an action or trigger in a flow chart. |
ActionHistoryIterator |
getActionHistory(java.lang.String flowChartName,
java.lang.String actionName,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns historical execution timestamps which occurred within the lower and upper date boundaries for an action or trigger in a flow chart. |
AgentAdministrator |
getAgentAdministrator()
Returns the agent administrator for this engine instance, which is responsible for registering agents, unregistering agents, monitoring agents, and accepting responses from agents. |
java.lang.String |
getAuditTrailExpiration()
Returns a time expression indicating how old individual audit trail entries in the Flux audit trail must be before they are automatically pruned. |
long |
getAverageRuntime(java.lang.String namespace)
Returns the average length of execution time in milliseconds for all runs in the specified namespace. |
long |
getAverageRuntime(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the average length of execution time in milliseconds for all runs in the specified namespace which occurred within the lower and upper date boundaries. |
long |
getAverageRuntimeForAction(java.lang.String flowChartName,
java.lang.String actionName)
Returns the average length of execution time for an action or trigger in a specific flow chart. |
long |
getAverageRuntimeForAction(java.lang.String flowChartName,
java.lang.String actionName,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the average length of execution time for an action or trigger in a specific flow chart for all execution times which occurred in the specified date boundaries. |
long |
getAverageWaitTimeForTrigger(java.lang.String flowChartName,
java.lang.String triggerName)
Returns the average length of time a trigger in a specific flow chart took to fire. |
long |
getAverageWaitTimeForTrigger(java.lang.String flowChartName,
java.lang.String triggerName,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the average length of time a trigger in a specific flow chart took to fire during the specified date boundaries. |
FlowChartIterator |
getByState(java.lang.String namespace,
SuperState superState,
SubState subState)
Returns all flow charts in the given state and namespace, ordered first by flow chart super-state, then by flow chart sub-state, then by namespace. |
int |
getConcurrencyLevel()
Returns the concurrency throttle limit in the root node of the runtime configuration tree, assuming the root concurrency throttle expression is "/ <= N", where N is the limit. |
Configuration |
getConfiguration()
Returns the configuration for this engine instance. |
float |
getCpuUsage()
Returns the percentage of CPU usage for the system running the Flux engine. |
FlowChartElementIterator |
getFlowChartElements(java.lang.String namespace)
Returns the fundamental components of all flow charts, ordered by flow chart name, whose names match the specified hierarchical flow chart namespace expression. |
FlowChartElementIterator |
getFlowChartElements(java.lang.String namespace,
SortOrder sortOrder)
Returns the fundamental components of all flow charts, ordered by flow chart name, whose names match the specified hierarchical flow chart namespace expression. |
FlowChartElementIterator |
getFlowChartElements(java.lang.String namespace,
SuperState superState,
java.util.Set<SubState> subStates,
java.lang.String engineName,
java.lang.String actionName,
java.lang.String messageFilter)
Returns the fundamental components of all running flow contexts within executing flow charts that match the specified search criteria, which are described in the method parameters. |
FlowChartElementIterator |
getFlowChartElements(java.lang.String namespace,
SuperState superState,
java.util.Set<SubState> subStates,
java.lang.String engineName,
java.lang.String actionName,
java.lang.String messageFilter,
SortOrder sortOrder)
Returns the fundamental components of all running flow contexts within executing flow charts that match the specified search criteria, which are described in the method parameters. |
FlowChartIterator |
getFlowCharts(java.lang.String namespace)
Returns all flow charts, ordered by flow chart name, whose names match the specified hierarchical flow chart namespace expression. |
long |
getFreePhysicalMemory()
Returns the amount of physical memory on the system running the engine, in kilobytes. |
long |
getFreeVirtualMemory()
Returns the amount of free virtual memory on the system running the engine, in kilobytes. |
java.lang.String |
getLogExpiration()
Returns a time expression indicating how old individual log entries in the Flux logs must be before they are automatically pruned. |
long |
getLongestRuntime(java.lang.String namespace)
Returns the runtime in milliseconds of the longest flow chart run in the specified namespace. |
long |
getLongestRuntime(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the runtime in milliseconds of the longest flow chart run in the specified namespace which occurred within the lower and upper date boundaries. |
long |
getLongestRuntimeForAction(java.lang.String flowChartName,
java.lang.String actionName)
Returns the longest runtime in milliseconds for an action or trigger in a specific flow chart. |
long |
getLongestRuntimeForAction(java.lang.String flowChartName,
java.lang.String actionName,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the longest runtime in milliseconds for an action or trigger in a specific flow chart for all execution times which occurred in the specified date boundaries. |
long |
getOpenRunCount(java.lang.String namespace)
Returns the total number of flow chart runs that have not completed in the specified namespace which occurred within the lower and upper date boundaries. |
long |
getOpenRunCount(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the total number of flow chart runs which have not completed in the specified namespace which occurred within the lower and upper date boundaries. |
RepositoryAdministrator |
getRepositoryAdministrator()
Returns the repository administrator which can be used to retrieve or manage flow charts in the flow chart repository. |
long |
getRunCount(java.lang.String namespace)
Returns the total number of flow chart runs in the specified namespace. |
long |
getRunCount(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the total number of flow chart runs in the specified namespace that occurred within the lower and upper date boundaries. |
FlowChartRunIterator |
getRuns(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns all runs in the specified namespace that occurred within the lower and upper date boundaries. |
FlowChartRunIterator |
getRuns(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
SortOrder sortOrder)
Returns all runs in the specified namespace that occurred within the lower and upper date boundaries. |
RuntimeConfigurationNode |
getRuntimeConfiguration()
Returns the existing runtime configuration for this engine instance. |
SecurityAdministrator |
getSecurityAdministrator()
Returns the security administrator for this Flux engine, which is responsible for managing users, roles, and other security issues. |
long |
getTotalPhysicalMemory()
Returns the total amount of virtual memory on the system running the engine, in kilobytes. |
long |
getTotalVirtualMemory()
Returns the total amount of virtual memory for the system running the engine, in kilobytes. |
long |
getUnsuccessfulRunCount(java.lang.String namespace)
Returns the total number of unsuccessful flow chart runs in the specified namespace. |
long |
getUnsuccessfulRunCount(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound)
Returns the total number of unsuccessful flow chart runs in the specified namespace which occurred within the lower and upper date boundaries. |
java.lang.String |
getVersion()
Returns version information for this Flux engine. |
long |
interrupt(java.lang.String namespace)
Interrupts the specified flow charts as soon as possible. |
boolean |
isDisposed()
Indicates whether the engine has been disposed and is no longer usable. |
boolean |
isLoggedIn()
For security purposes, indicates whether the current thread is logged into the engine as the specified user. |
boolean |
isRunning()
Indicates if the engine has been started. |
boolean |
isSecured()
Indicates whether a Flux engine has security enabled on it. |
boolean |
join(java.lang.String namespace,
java.lang.String timeoutTimeExpression)
Waits (blocks) until there are no flow charts in the specified namespace or a timeout occurs. |
boolean |
join(java.lang.String namespace,
java.lang.String timeoutTimeExpression,
java.lang.String pollingDelayTimeExpression)
Waits (blocks) until there are no flow charts in the specified namespace or a timeout occurs. |
void |
login(java.lang.String username,
java.lang.String password)
For security purposes, logs the caller into the engine as the specified user. |
void |
logout()
For security purposes, logs the caller out of the engine as the specified user. |
long |
pause(java.lang.String namespace)
Pauses all flow charts specified by a hierarchical flow chart namespace expression. |
void |
ping()
An empty method that performs absolutely no function except to verify that the engine is alive. |
java.lang.String |
put(FlowChart flowChart)
Adds a new flow chart for execution, or if the flow chart already exists, modifies it. |
java.lang.String |
put(FlowChart flowChart,
boolean replace)
Adds a new flow chart for execution, or if the flow chart already exists on the engine, replaces it with a new one, if replace is set to true. |
long |
raiseSignal(java.lang.String namespace,
java.lang.String signal)
Raises the specified signal on all flow charts specified by a hierarchical flow chart namespace expression. |
long |
recover(java.lang.String namespace)
Restarts all flow contexts that are in the ERROR super-state and the FAILED sub-state from the beginning of the main-line (not the default error handler) flow chart transaction that led to the FAILED state. |
long |
recover(java.lang.String namespace,
boolean skipOffendingAction)
Restarts all flow contexts that are in the ERROR super-state and the FAILED sub-state from the beginning of the main-line (not the default error handler) flow chart transaction that led to the FAILED state. |
long |
remove(java.lang.String namespace)
Removes executing flow charts from the engine. |
long |
rename(java.lang.String oldNamespace,
java.lang.String newNamespace)
Renames all flow charts in the old namespace to the new namespace. |
void |
restart(Configuration configuration)
Provides a way to reconfigure an engine without creating a new engine object. |
long |
restart(java.lang.String namespace)
Restarts all flow charts specified by a hierarchical flow chart namespace expression. |
long |
resume(java.lang.String namespace)
Resumes all flow charts specified by the hierarchical flow chart namespace expression. |
AuditTrailIterator |
scanAuditTrail(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
java.util.Set<java.lang.String> auditTrailEventNames,
java.lang.String messageFilter)
Returns an ordered result of audit trail entries from the Flux audit trail. |
AuditTrailIterator |
scanAuditTrail(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
java.util.Set<java.lang.String> auditTrailEventNames,
java.lang.String messageFilter,
SortOrder sortOrder)
Returns an ordered result of audit trail entries from the Flux audit trail. |
AuditTrailIterator |
scanAuditTrailByUser(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
java.util.Set<java.lang.String> auditTrailEventNames,
java.lang.String messageFilter,
java.lang.String username)
Returns an ordered result of audit trail entries from the Flux audit trail. |
AuditTrailIterator |
scanAuditTrailByUser(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
java.util.Set<java.lang.String> auditTrailEventNames,
java.lang.String messageFilter,
java.lang.String username,
SortOrder sortOrder)
Returns an ordered result of audit trail entries from the Flux audit trail. |
LogIterator |
scanLogs(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
Level loggingLevel,
java.lang.String logger,
java.lang.String messageFilter,
java.lang.String engineName)
Returns an ordered result of log entries from the Flux logs. |
LogIterator |
scanLogs(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
Level loggingLevel,
java.lang.String logger,
java.lang.String messageFilter,
java.lang.String engineName,
SortOrder sortOrder)
Returns an ordered result of log entries from the Flux logs. |
LogIterator |
scanLogsByUser(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
Level loggingLevel,
java.lang.String logger,
java.lang.String messageFilter,
java.lang.String engineName,
java.lang.String username)
Returns an ordered result of log entries from the Flux logs. |
LogIterator |
scanLogsByUser(java.lang.String namespace,
java.util.Date lowerBound,
java.util.Date upperBound,
Level loggingLevel,
java.lang.String logger,
java.lang.String messageFilter,
java.lang.String engineName,
java.lang.String username,
SortOrder sortOrder)
Returns an ordered result of log entries from the Flux logs. |
void |
sendToAuditTrail(java.lang.String eventName,
java.lang.String eventMessage)
Publishes an audit trail event using the given name and message. |
void |
setAuditTrailExpiration(java.lang.String auditTrailExpiration)
Sets a time expression indicating how old individual audit trail entries in the Flux audit trail must be before they are automatically pruned. |
void |
setConcurrencyLevel(int level)
Sets the concurrency throttle limit in the root node of the runtime configuration tree, assuming the root concurrency throttle expression is "/ <= N", where N is the limit or level. |
void |
setLogExpiration(java.lang.String logExpiration)
Sets a time expression indicating how old individual log entries in the Flux logs must be before they are automatically pruned. |
void |
setRuntimeConfiguration(RuntimeConfigurationNode runtimeConfiguration)
Sets the runtime configuration for this engine instance to a new runtime configuration after this engine has been instantiated. |
long |
size()
Returns the number of flow charts in the engine. |
long |
size(java.lang.String namespace)
Returns the number of flow charts in the specified hierarchical flow chart namespace within the engine. |
long |
sizeByState(java.lang.String namespace,
SuperState superState,
SubState subState)
Returns the number of flow charts in the specified state and hierarchical flow chart namespace within the engine. |
void |
start()
Instructs the engine to start executing flow charts. |
void |
stop()
Instructs the engine to stop executing flow charts. |
Method Detail |
---|
long clear() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void clearAuditTrail() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void clearLogs() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void clearRunHistory() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void clearRunHistory(java.lang.String namespace) throws EngineException
namespace
- The hierarchical flow chart path or absolute flow chart
name. The namespace may include the wildcard characters
"*" and "?". The "*" character matches any character zero
or more times, and the "?" character matches any character
exactly once.
java.lang.IllegalArgumentException
- If namespace is null or empty.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long clearSignal(java.lang.String namespace, java.lang.String signal) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.signal
- The name of the signal to clear.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long clearSignals(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void dispose() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long expedite(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.java.util.List<java.lang.String> findBusinessIntervalUsages(java.lang.String businessIntervalNamespace) throws EngineException
businessIntervalNamespace
- Namespace to a business interval located in the repository.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.ForecastIterator forecast(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range that includes
expected firing times.upperBound
- The right edge, exclusive, of the time range that
includes expected firing times.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartIterator get() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChart get(java.lang.String flowChartName) throws EngineException
flowChartName
- Specifies a flow chart in the hierarchical flow chart
name space.
java.lang.IllegalArgumentException
- If flowChartName is null, empty, or
contains a "*", "?", "%", "_", ".", or "$"
character.
EngineException
- If the flow chart name ends with a
trailing slash, which refers to a branch
in the hierarchical flow chart namespace;
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.ActionHistoryIterator getActionHistory(java.lang.String flowChartName, java.lang.String actionName) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.actionName
- The name identifying an action or trigger in a flow
chart.
java.lang.IllegalArgumentException
- If the flow chart name or action name is
null or empty or flow chart name contains
a wildcard.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.ActionHistoryIterator getActionHistory(java.lang.String flowChartName, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
flowChartName
- The absolute path to a flow chart. Wildcards are not
permitted.lowerBound
- The left edge, inclusive, of the time range of runs to
be returned.upperBound
- The right edge, exclusive, of the time range of runs
to be returned.
java.lang.IllegalArgumentException
- If the flow chart name is null or empty,
the flow chart name contains a wildcard,
the lower bound is null, the upper bound
is null, or the lower bound is greater
than or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.ActionHistoryIterator getActionHistory(java.lang.String flowChartName, java.lang.String actionName, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.actionName
- The name identifying an action in a flow chart.lowerBound
- The left edge, inclusive, of the time range of runs to
be returned.upperBound
- The right edge, exclusive, of the time range of runs
to be returned.
java.lang.IllegalArgumentException
- If the flow chart name or action name is
null or empty, the flow chart name
contains a wildcard, the lower bound is
null, the upper bound is null, or the
lower bound is greater than or equal to
the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.ActionHistoryIterator getActionHistory(java.lang.String flowChartName, java.util.Date lowerBound, java.util.Date upperBound, java.lang.String actionType) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.lowerBound
- The left edge, inclusive, of the time range of runs to
be returned.upperBound
- The right edge, exclusive, of the time range of runs
to be returned.actionType
- The bean display name for the trigger or action in a
flow chart. For example, the action type for a:
java.lang.IllegalArgumentException
- If the flow chart name or action type is
null or empty, the flow chart name
contains a wildcard, the lower bound is
null, the upper bound is null, or the
lower bound is greater than or equal to
the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.AgentAdministrator getAgentAdministrator() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.java.lang.String getAuditTrailExpiration() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.LoggerType.INTERNAL_ASYNCHRONOUS
,
LoggerType.INTERNAL_SYNCHRONOUS
,
Configuration.AUDIT_TRAIL_EXPIRATION
long getAverageRuntime(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
java.lang.IllegalArgumentException
- If the namespace is null or empty.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getAverageRuntime(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
returned.upperBound
- The right edge, exclusive, of the time range of runs to
be returned.
java.lang.IllegalArgumentException
- If the namespace is null or empty or the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getAverageRuntimeForAction(java.lang.String flowChartName, java.lang.String actionName) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.actionName
- The name identifying an action or trigger in a
specific flow chart.
java.lang.IllegalArgumentException
- If the namespace or action name is null or
empty or namespace contains a wildcard.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getAverageRuntimeForAction(java.lang.String flowChartName, java.lang.String actionName, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.actionName
- The name identifying an action or trigger in a
specific flow chart.lowerBound
- The left edge, inclusive, of the time range of runtime
averages to be returned.upperBound
- The right edge, exclusive, of the time range of
runtime averages to be returned.
java.lang.IllegalArgumentException
- If the flow chart name or action name is
null or empty, the flow chart name
contains a wildcard, the lower bound is
null, the upper bound is null, or the
lower bound is greater than or equal to
the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getAverageWaitTimeForTrigger(java.lang.String flowChartName, java.lang.String triggerName) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
trigger. Wildcards are not permitted.triggerName
- The name identifying a trigger in a specifc flow
chart.
java.lang.IllegalArgumentException
- If the flow chart name or trigger name is
null or empty or contain a wildcard.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getAverageWaitTimeForTrigger(java.lang.String flowChartName, java.lang.String triggerName, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
trigger. Wildcards are not permitted.triggerName
- The name identifying a trigger in a specific flow
chart.lowerBound
- The left edge, inclusive, of the time range of wait
averages to be returned.upperBound
- The right edge, exclusive, of the time range of wait
averages to be returned.
java.lang.IllegalArgumentException
- If the flow chart name or trigger name is
null or empty or the flow chart name
contains a wildcard.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartIterator getByState(java.lang.String namespace, SuperState superState, SubState subState) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.superState
- The super-state from which flow charts are selected.subState
- The sub-state from which flow charts are selected.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.int getConcurrencyLevel() throws EngineException
EngineException
- If the root concurrency throttle expression is not
"/ <= N" or if a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration getConfiguration() throws EngineException
EngineException
- If security is enabled and insufficient security
privileges have been granted to call this method.
EngineCommunicationException
- If a networking error occurs.float getCpuUsage() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartElementIterator getFlowChartElements(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
java.lang.IllegalArgumentException
- If namespace is null, empty, does not
start with a "/" character, or includes
the illegal namespace characters ".", "_",
"%", or "$".
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartElementIterator getFlowChartElements(java.lang.String namespace, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.sortOrder
- The sorting algorithm used to order the flow chart elements.
java.lang.IllegalArgumentException
- If namespace is null, empty, does not
start with a "/" character, or includes
the illegal namespace characters ".", "_",
"%", or "$".
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartElementIterator getFlowChartElements(java.lang.String namespace, SuperState superState, java.util.Set<SubState> subStates, java.lang.String engineName, java.lang.String actionName, java.lang.String messageFilter) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.superState
- All results contain a super-state that matches
superState. If null, results can contain any
super-state.subStates
- All results contain a sub-state that matches one of
the specified sub-states. If null, results can contain
any sub-state.engineName
- All results contain an engine that matches engineName.
If null, results can contain any engine name.actionName
- All results contain an action that matches actionName.
If null, results can contain any action namemessageFilter
- All results include messages that contain the
messageFilter in its entirety. If null, results can
contain any message.
java.lang.IllegalArgumentException
- If namespace is null, empty, does not
start with a "/" character, or includes
the illegal namespace characters ".", "_",
"%", or "$".
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartElementIterator getFlowChartElements(java.lang.String namespace, SuperState superState, java.util.Set<SubState> subStates, java.lang.String engineName, java.lang.String actionName, java.lang.String messageFilter, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.superState
- All results contain a super-state that matches
superState. If null, results can contain any
super-state.subStates
- All results contain a sub-state that matches one of
the specified sub-states. If null, results can contain
any sub-state.engineName
- All results contain an engine that matches engineName.
If null, results can contain any engine name.actionName
- All results contain an action that matches actionName.
If null, results can contain any action namemessageFilter
- All results include messages that contain the
messageFilter in its entirety. If null, results can
contain any message.sortOrder
- The sorting algorithm used to order the flow chart elements.
java.lang.IllegalArgumentException
- If namespace is null, empty, does not
start with a "/" character, or includes
the illegal namespace characters ".", "_",
"%", or "$".
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartIterator getFlowCharts(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getFreePhysicalMemory() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getFreeVirtualMemory() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.java.lang.String getLogExpiration() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.LoggerType.INTERNAL_ASYNCHRONOUS
,
LoggerType.INTERNAL_SYNCHRONOUS
,
Configuration.LOG_EXPIRATION
long getLongestRuntime(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
java.lang.IllegalArgumentException
- If the namespace is null or empty.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getLongestRuntime(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
included in the search.upperBound
- The right edge, exclusive, of the time range of runs to
be included in the search.
java.lang.IllegalArgumentException
- If the namespace is null or empty or the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getLongestRuntimeForAction(java.lang.String flowChartName, java.lang.String actionName) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.actionName
- The name identifying an action or trigger in a
specific flow chart.
java.lang.IllegalArgumentException
- If the namespace or action name is null or
empty or namespace contains a wildcard.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getLongestRuntimeForAction(java.lang.String flowChartName, java.lang.String actionName, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
flowChartName
- The absolute path to the flow chart containing the
action or trigger. Wildcards are not permitted.actionName
- The name identifying an action or trigger in a
specific flow chart.lowerBound
- The left edge, inclusive, of the time range of runs to
be included.upperBound
- The right edge, exclusive, of the time range of runs
to be included.
java.lang.IllegalArgumentException
- If the flow chart name or action name is
null or empty, the flow chart name
contains a wildcard, the lower bound is
null, the upper bound is null, or the
lower bound is greater than or equal to
the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getOpenRunCount(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
java.lang.IllegalArgumentException
- If the namespace is null or empty.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getOpenRunCount(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
returned.upperBound
- The right edge, exclusive, of the time range of runs to
be returned.
java.lang.IllegalArgumentException
- If the namespace is null or empty or the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.RepositoryAdministrator getRepositoryAdministrator() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getRunCount(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
java.lang.IllegalArgumentException
- If the namespace is null or empty.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getRunCount(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
returned.upperBound
- The right edge, exclusive, of the time range of runs to
be returned.
java.lang.IllegalArgumentException
- If the namespace is null or empty or the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartRunIterator getRuns(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
returned.upperBound
- The right edge, exclusive, of the time range of runs to
be returned.
java.lang.IllegalArgumentException
- If the namespace is null or empty, the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.FlowChartRunIterator getRuns(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
returned.upperBound
- The right edge, exclusive, of the time range of runs to
be returned.sortOrder
- The sorting algorithm used to order the runs.
java.lang.IllegalArgumentException
- If the namespace is null or empty, the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.RuntimeConfigurationNode getRuntimeConfiguration() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.RUNTIME_CONFIGURATION
,
getConfiguration()
,
Configuration.getRuntimeConfiguration()
SecurityAdministrator getSecurityAdministrator() throws EngineException
EngineException
- If security is enabled and insufficient security
privileges have been granted to call this method.
EngineCommunicationException
- If a networking error occurs.long getTotalPhysicalMemory() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getTotalVirtualMemory() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getUnsuccessfulRunCount(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
java.lang.IllegalArgumentException
- If the namespace is null or empty.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long getUnsuccessfulRunCount(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.lowerBound
- The left edge, inclusive, of the time range of runs to be
returned.upperBound
- The right edge, exclusive, of the time range of runs to
be returned.
java.lang.IllegalArgumentException
- If the namespace is null or empty or the
lower bound is null, the upper bound is
null, or the lower bound is greater than
or equal to the upper bound.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.java.lang.String getVersion() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long interrupt(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.boolean isDisposed() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.boolean isLoggedIn() throws EngineCommunicationException
EngineCommunicationException
- If a networking error occurs.boolean isRunning() throws EngineException
EngineException
- If security is enabled and insufficient security
privileges have been granted to call this method.
EngineCommunicationException
- If a networking error occurs.boolean isSecured() throws EngineCommunicationException
EngineCommunicationException
- If a networking error occurs.boolean join(java.lang.String namespace, java.lang.String timeoutTimeExpression) throws EngineException
namespace
- A number of flow charts in the hierarchical
flow chart namespace. The namespace may
include the wildcard characters "*" and "?".
The "*" character matches any character zero
or more times, and the "?" character matches
any character exactly once.timeoutTimeExpression
- The maximum amount of time that this method
blocks while monitoring the specified
namespace. The timeout time expression must be
longer than the SYSTEM_DELAY engine
configuration property.
EngineException
- If namespace is null, timeoutTimeExpression is
null, timeoutTimeExpression is not a positive time
expression, timeoutTimeExpression is shorter than
SYSTEM_DELAY, or a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.SYSTEM_DELAY
boolean join(java.lang.String namespace, java.lang.String timeoutTimeExpression, java.lang.String pollingDelayTimeExpression) throws EngineException
namespace
- A number of flow charts in the
hierarchical flow chart namespace. The
namespace may include the wildcard
characters "*" and "?". The "*" character
matches any character zero or more times,
and the "?" character matches any
character exactly once.timeoutTimeExpression
- The maximum amount of time that this
method blocks while monitoring the
specified namespace. The timeout time
expression must be longer than the
polling delay time expression.pollingDelayTimeExpression
- The frequency at which this method checks
the database to detect when there are no
more flow charts. The polling delay time
expression must be shorter than the
timeout time expression.
EngineException
- If namespace is null, timeoutTimeExpression is
null, timeoutTimeExpression is not a positive time
expression, pollingDelayTimeExpression is null,
pollingDelayTimeExpression is not a positive time
expression, timeoutTimeExpression is shorter than
pollingDelayTimeExpression, or a system error
occurs.
EngineCommunicationException
- If a networking error occurs.void login(java.lang.String username, java.lang.String password) throws EngineException
username
- The name of the user logging in.password
- The password of the user logging in.
java.lang.IllegalArgumentException
- If username is null or empty or if password is
null or empty.
EngineException
- If the username and password cannot be
authenticated or if a system error occurs during
the login process.
EngineCommunicationException
- If a networking error occurs.void logout() throws EngineException
EngineException
- If the specified username is not logged into the
engine.
EngineCommunicationException
- If a networking error occurs.long pause(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void ping() throws EngineException
EngineException
- If the engine is already disposed.
EngineCommunicationException
- If a networking error occurs.java.lang.String put(FlowChart flowChart) throws EngineException
flowChart
- The flow chart to put into the engine.
EngineException
- If the structure of the flow chart would be
changed, if a new flow chart is used to modify an
existing one, or if a system error occurs.
EngineCommunicationException
- If a networking error occurs.java.lang.String put(FlowChart flowChart, boolean replace) throws EngineException
flowChart
- The flow chart to put into the engine.replace
- Overwrites flow chart on the engine if set to true.
EngineException
- If the structure of the flow chart would be
changed, and replace is false,
or if a system error occurs.
EngineCommunicationException
- If a networking error occurs.put(FlowChart)
long raiseSignal(java.lang.String namespace, java.lang.String signal) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.signal
- The name of the signal to raise.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long recover(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long recover(java.lang.String namespace, boolean skipOffendingAction) throws EngineException
namespace
- A number of flow charts in the hierarchical flow
chart namespace. The namespace may include the
wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.skipOffendingAction
- When true, does not re-execute the offending
action that generated the error, providing the
offending action is skippable.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.Action.setSkippable(boolean)
long remove(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long rename(java.lang.String oldNamespace, java.lang.String newNamespace) throws EngineException
oldNamespace
- The namespace to be renamed.newNamespace
- The target namespace.
EngineException
- If either namespace is null or empty, both
namespaces are equal, or a system error occurs.
EngineCommunicationException
- If a networking error occurs.void restart(Configuration configuration) throws EngineException
configuration
- Properties that control how this engine behaves.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long restart(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long resume(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.AuditTrailIterator scanAuditTrail(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, java.util.Set<java.lang.String> auditTrailEventNames, java.lang.String messageFilter) throws EngineException
namespace
- A number of flow charts in the hierarchical
flow chart namespace. The namespace may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.
If namespace is null, audit trail entries from
any flow chart are returned.lowerBound
- The left edge, inclusive, of the time range of
audit trail entries to be returned.upperBound
- The right edge, exclusive, of the time range of
audit trail entries to be returned.messageFilter
- A filter that restricts the results to those
audit trail entries that match the specified
message filter. The message filter may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.auditTrailEventNames
- Filters out all audit trail events except for
the specified events. If null or empty, all
audit trail events are included.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.AuditTrailIterator scanAuditTrail(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, java.util.Set<java.lang.String> auditTrailEventNames, java.lang.String messageFilter, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical
flow chart namespace. The namespace may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.
If namespace is null, audit trail entries from
any flow chart are returned.lowerBound
- The left edge, inclusive, of the time range of
audit trail entries to be returned.upperBound
- The right edge, exclusive, of the time range of
audit trail entries to be returned.auditTrailEventNames
- Filters out all audit trail events except for
the specified events. If null or empty, all
audit trail events are included.messageFilter
- A filter that restricts the results to those
audit trail entries that match the specified
message filter. The message filter may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.sortOrder
- The sorting algorithm used to order the audit trail.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.AuditTrailIterator scanAuditTrailByUser(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, java.util.Set<java.lang.String> auditTrailEventNames, java.lang.String messageFilter, java.lang.String username) throws EngineException
namespace
- A number of flow charts in the hierarchical
flow chart namespace. The namespace may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.
If namespace is null, audit trail entries from
any flow chart are returned.lowerBound
- The left edge, inclusive, of the time range of
audit trail entries to be returned.upperBound
- The right edge, exclusive, of the time range of
audit trail entries to be returned.auditTrailEventNames
- Filters out all audit trail events except for
the specified events. If null or empty, all
audit trail events are included.messageFilter
- A filter that restricts the results to those
audit trail entries that match the specified
message filter. The message filter may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.username
- The name of the user responsible for generating
this audit trail entry. If username is null,
audit trail entries from any user are
returned.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.AuditTrailIterator scanAuditTrailByUser(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, java.util.Set<java.lang.String> auditTrailEventNames, java.lang.String messageFilter, java.lang.String username, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical
flow chart namespace. The namespace may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.
If namespace is null, audit trail entries from
any flow chart are returned.lowerBound
- The left edge, inclusive, of the time range of
audit trail entries to be returned.upperBound
- The right edge, exclusive, of the time range of
audit trail entries to be returned.auditTrailEventNames
- Filters out all audit trail events except for
the specified events. If null or empty, all
audit trail events are included.messageFilter
- A filter that restricts the results to those
audit trail entries that match the specified
message filter. The message filter may include
the wildcard characters "*" and "?". The "*"
character matches any character zero or more
times, and the "?" character matches any
character exactly once.username
- The name of the user responsible for generating
this audit trail entry. If username is null,
audit trail entries from any user are
returned.sortOrder
- The sorting algorithm used to order the audit trail.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.LogIterator scanLogs(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, Level loggingLevel, java.lang.String logger, java.lang.String messageFilter, java.lang.String engineName) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
If namespace is null, log entries from any flow chart
are returned.lowerBound
- The left edge, inclusive, of the time range of log
entries to be returned.upperBound
- The right edge, exclusive, of the time range of log
entries to be returned.loggingLevel
- The granularity of log entries to return.logger
- One of the three engine loggers -- "client",
"flow_chart", or "system" -- to which the returned log
entries are restricted. If logger is null, log entries
generated by any logger are returned.messageFilter
- A filter that restricts the results to those log
entries that match the specified message filter. The
message filter may include the wildcard characters "*"
and "?". The "*" character matches any character zero
or more times, and the "?" character matches any
character exactly once.engineName
- Each engine in a cluster is named. Restricts the
returned log entries to those entries matching the
specified engine. If engine name is null, log entries
from any engine are returned.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.CLIENT_LOGGER
,
Configuration.FLOW_CHART_LOGGER
,
Configuration.SYSTEM_LOGGER
LogIterator scanLogs(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, Level loggingLevel, java.lang.String logger, java.lang.String messageFilter, java.lang.String engineName, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
If namespace is null, log entries from any flow chart
are returned.lowerBound
- The left edge, inclusive, of the time range of log
entries to be returned.upperBound
- The right edge, exclusive, of the time range of log
entries to be returned.loggingLevel
- The granularity of log entries to return.logger
- One of the three engine loggers -- "client",
"flow_chart", or "system" -- to which the returned log
entries are restricted. If logger is null, log entries
generated by any logger are returned.messageFilter
- A filter that restricts the results to those log
entries that match the specified message filter. The
message filter may include the wildcard characters "*"
and "?". The "*" character matches any character zero
or more times, and the "?" character matches any
character exactly once.engineName
- Each engine in a cluster is named. Restricts the
returned log entries to those entries matching the
specified engine. If engine name is null, log entries
from any engine are returned.sortOrder
- The sorting algorithm used to order the logs.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
or a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.CLIENT_LOGGER
,
Configuration.FLOW_CHART_LOGGER
,
Configuration.SYSTEM_LOGGER
LogIterator scanLogsByUser(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, Level loggingLevel, java.lang.String logger, java.lang.String messageFilter, java.lang.String engineName, java.lang.String username) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
If namespace is null, log entries from any flow chart
are returned.lowerBound
- The left edge, inclusive, of the time range of log
entries to be returned.upperBound
- The right edge, exclusive, of the time range of log
entries to be returned.loggingLevel
- The granularity of log entries to return.logger
- One of the three engine loggers — "client",
"flow_chart", or "system" — to which the
returned log entries are restricted. If logger is
null, log entries generated by any logger are
returned.messageFilter
- A filter that restricts the results to those log
entries that match the specified message filter. The
message filter may include the wildcard characters "*"
and "?". The "*" character matches any character zero
or more times, and the "?" character matches any
character exactly once.engineName
- Each engine in a cluster is named. Restricts the
returned log entries to those entries matching the
specified engine. If engine name is null, log entries
from any engine are returned.username
- The name of the user responsible for generating this
log entry. If username is null, log entries from any
user are returned.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
the logging level is null, username is
null, or a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.CLIENT_LOGGER
,
Configuration.FLOW_CHART_LOGGER
,
Configuration.SYSTEM_LOGGER
LogIterator scanLogsByUser(java.lang.String namespace, java.util.Date lowerBound, java.util.Date upperBound, Level loggingLevel, java.lang.String logger, java.lang.String messageFilter, java.lang.String engineName, java.lang.String username, SortOrder sortOrder) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
If namespace is null, log entries from any flow chart
are returned.lowerBound
- The left edge, inclusive, of the time range of log
entries to be returned.upperBound
- The right edge, exclusive, of the time range of log
entries to be returned.loggingLevel
- The granularity of log entries to return.logger
- One of the three engine loggers — "client",
"flow_chart", or "system" — to which the
returned log entries are restricted. If logger is
null, log entries generated by any logger are
returned.messageFilter
- A filter that restricts the results to those log
entries that match the specified message filter. The
message filter may include the wildcard characters "*"
and "?". The "*" character matches any character zero
or more times, and the "?" character matches any
character exactly once.engineName
- Each engine in a cluster is named. Restricts the
returned log entries to those entries matching the
specified engine. If engine name is null, log entries
from any engine are returned.username
- The name of the user responsible for generating this
log entry. If username is null, log entries from any
user are returned.sortOrder
- The sorting algorithm used to order the logs.
java.lang.IllegalArgumentException
- If the lower bound is null, the upper
bound is null, or the lower bound is
greater than or equal to the upper bound.
EngineException
- If the Flux engine's logger type is not
LoggerType.ASYNCHRONOUS or LoggerType.SYNCHRONOUS,
the logging level is null, username is
null, or a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.CLIENT_LOGGER
,
Configuration.FLOW_CHART_LOGGER
,
Configuration.SYSTEM_LOGGER
void sendToAuditTrail(java.lang.String eventName, java.lang.String eventMessage) throws EngineException
eventName
- The name of the audit trail event to be published.eventMessage
- The accompanying message for the audit trail event to
be published.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.AuditTrailTrigger
void setAuditTrailExpiration(java.lang.String auditTrailExpiration) throws EngineException
auditTrailExpiration
- A time expression indicating how old individual
audit trail entries in the Flux audit trail
must be before they are automatically pruned. A
null audit trail expiration indicates that
audit trail entries never expire.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.LoggerType.INTERNAL_ASYNCHRONOUS
,
LoggerType.INTERNAL_SYNCHRONOUS
,
Configuration.AUDIT_TRAIL_EXPIRATION
void setConcurrencyLevel(int level) throws EngineException
level
- The concurrency throttle limit in the root node of the runtime
configuration tree.
EngineException
- If the root concurrency throttle expression is not
"/ <= N", the Flux engine is secured and the
caller does not have administrator privileges, or a
system error occurs.
EngineCommunicationException
- If a networking error occurs.void setLogExpiration(java.lang.String logExpiration) throws EngineException
logExpiration
- A time expression indicating how old individual log
entries in the Flux logs must be before they are
automatically pruned. A null log expiration indicates
that log entries never expire.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.LoggerType.INTERNAL_ASYNCHRONOUS
,
LoggerType.INTERNAL_SYNCHRONOUS
,
Configuration.LOG_EXPIRATION
void setRuntimeConfiguration(RuntimeConfigurationNode runtimeConfiguration) throws EngineException
runtimeConfiguration
- The new runtime configuration for this engine
instance.
java.lang.IllegalArgumentException
- If runtimeConfiguration is null or
invalid.
EngineException
- The Flux engine is secured and the caller
does not have administrator privileges or
a system error occurs.
EngineCommunicationException
- If a networking error occurs.Configuration.RUNTIME_CONFIGURATION
long size() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long size(java.lang.String namespace) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.long sizeByState(java.lang.String namespace, SuperState superState, SubState subState) throws EngineException
namespace
- A number of flow charts in the hierarchical flow chart
namespace. The namespace may include the wildcard
characters "*" and "?". The "*" character matches any
character zero or more times, and the "?" character
matches any character exactly once.superState
- The super-state of flow charts to count.subState
- The sub-state of flow charts to count.
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void start() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.void stop() throws EngineException
EngineException
- If a system error occurs.
EngineCommunicationException
- If a networking error occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |