WebSphere:*,type=ProcessContainer
MBean ProcessContainer
The Business Flow Manager MBean provides an interface to perform some admin functions without using the WebSphere administrative console
Attribute Summary | |
java.lang.Integer | numberOfMessagesInRetentionQueue If one of the JMS messages on the internal Process Container message queue cannot be processed, it is moved to the retention queue. |
java.lang.Integer | numberOfMessagesInHoldQueue If one of the JMS messages on the Process Container retention message queue cannot be processed, it is moved to the hold queue. |
java.lang.String[] | stateObservers The active Business Flow Manager state observers. |
Operation Summary | |
void | deleteInvalidProcessTemplate( Cancelling the installation of a business process application may result in an invalid process template in the Business Process Choreographer database. |
void | replayHoldQueueMessages() If one of the JMS messages on the Process Container retention message queue cannot be processed, it is moved to the hold queue. |
void | replayRetentionQueueMessages() If one of the JMS messages on the internal Process Container message queue cannot be processed, it is moved to the retention queue. |
int | deleteCompletedProcessInstances( Deprecated. As of 7.0, replaced by method 'deleteCompletedProcessInstances' that takes an array of states and additional parameter 'completedAfter'. |
int | deleteCompletedProcessInstances( Delete completed process instances (and their child-processes) that belong to a process template. |
java.lang.String | observerRemoveDeletedInstancesData( Delete data corresponding to process instances which are deleted in the runtime from the Business Process Choreographer Observer's database |
java.lang.String | observerRemoveInstanceDataOfTemplate( Delete data corresponding to process instances belonging to a specific process template from the Business Process Choreographer Observer's database |
java.lang.String | observerForceRemoveInstanceData( Force delete data corresponding to process instances belonging to a specific process template from the Business Process Choreographer Observer's database. |
int | deleteAuditLog( This method deletes audit log entries whereby the parameters are specifying which audit log entries and how much audit log entries to delete. |
void | addStateObserver( This method adds a state observer to the list of state observer plugins. |
void | removeStateObserver( This method removes a state observer from the list of state observer plugins. |
void | migrateProcessInstances( This method migrates all process instances of a given template to a new version. |
Attribute Detail |
public java.lang.Integer numberOfMessagesInRetentionQueue
public java.lang.Integer numberOfMessagesInHoldQueue
public java.lang.String[] stateObservers
Operation Detail |
public void deleteInvalidProcessTemplate(java.lang.String templateName,
java.lang.String validFrom
)
templateName
-
Name of the template as displayed in the administrative console.validFrom
-
validFrom date of the template (in UTC) as displayed in the administrative console. The string should have the following format: 'yyyy-MM-ddThh:mm:ss'. For example, '2005-01-31T13:40:50'
public void replayHoldQueueMessages()
public void replayRetentionQueueMessages()
public int deleteCompletedProcessInstances(java.lang.String state,
java.lang.String templateName,
java.lang.String validFrom,
java.lang.String completedBefore,
java.lang.String startedBy
)
state
-
The to be considered state as a String. Allowed values are: 'finished', 'terminated', 'failed' and null. If null is specified no restriction based on the state occurs, i.e process instances in the state finished, failed and terminated will be deleted.templateName
-
The name of the process template (optional - can be null)validFrom
-
The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template (optional - can be null).completedBefore
-
The time (UTC) in format 'yyyy-MM-dd[Thh:mm:ss]' before the process must have been completed (optional - can be null)startedBy
-
The Id of the starter (optional - can be null)
public int deleteCompletedProcessInstances(java.lang.String[] states,
java.lang.String templateName,
java.lang.String validFrom,
java.lang.String completedAfter,
java.lang.String completedBefore,
java.lang.String startedBy
)
states
-
List of states to be considered as 'completed'. Allowed values are: 'finished', 'terminated', 'failed' and null. If null is specified no restriction based on the state occurs, i.e process instances in the state finished, failed and terminated will be deleted.templateName
-
The name of the process template (optional - can be null)validFrom
-
The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template (optional - can be null).completedAfter
-
The time (UTC) in format 'yyyy-MM-dd[Thh:mm:ss]' after which the process must have been completed (optional - can be null)completedBefore
-
The time (UTC) in format 'yyyy-MM-dd[Thh:mm:ss]' before the process must have been completed (optional - can be null)startedBy
-
The Id of the starter (optional - can be null)
public java.lang.String observerRemoveDeletedInstancesData(java.lang.String datasourceName,
java.lang.String dbSchemaName,
java.lang.String completedBefore
)
datasourceName
-
The name of the datasource to be used.dbSchemaName
-
The schema name used in the Observer database.completedBefore
-
The time (UTC) in format 'yyyy-MM-ddThh:mm:ss' before the process must have been deleted
public java.lang.String observerRemoveInstanceDataOfTemplate(java.lang.String datasourceName,
java.lang.String dbSchemaName,
java.lang.String templateName,
java.lang.String validFrom
)
datasourceName
-
The name of the datasource to be used.dbSchemaName
-
The schema name used in the Observer database.templateName
-
The name of the process template.validFrom
-
The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template..
public java.lang.String observerForceRemoveInstanceData(java.lang.String datasourceName,
java.lang.String dbSchemaName,
java.lang.String state,
java.lang.String templateName,
java.lang.String validFrom,
java.lang.String completedBefore
)
datasourceName
-
The name of the datasource to be used.dbSchemaName
-
The schema name used in the Observer database.state
-
The to be considered state as a String. Allowed values are: 'finished', 'terminated', 'failed'templateName
-
The name of the process template (optional - can be null)validFrom
-
The validFrom timestamp (UTC) in format 'yyyy-MM-ddThh:mm:ss' of the process template (optional - can be null).completedBefore
-
The time (UTC) in format 'yyyy-MM-ddThh:mm:ss' before the process must have been completed
public int deleteAuditLog(java.lang.String operation,
java.lang.String time,
java.lang.Integer slice
)
operation
-
Possible operations to execute: One of the strings 'all', 'time', 'processtime'. Any other exception will cause an IllegalArgumentException.time
-
In case of 'time' or 'processtime' the time (UTC) in format 'yyyy-MM-ddThh:mm:ss'. The time parameter defines that all audit log entries older than the specified time are deleted.slice
-
Maximum number of entries to delete. In case of operation 'all' that number must be greater than '0'.
public void addStateObserver(java.lang.String stateObserver
)
stateObserver
-
Name of the state observer to be added.
public void removeStateObserver(java.lang.String stateObserver
)
stateObserver
-
Name of the state observer to be removed.
public void migrateProcessInstances(java.lang.String templateName,
java.lang.String sourceValidFrom,
java.lang.String targetValidFrom,
java.lang.Integer slice
)
templateName
-
Name of process template.sourceValidFrom
-
Valid-from (UTC) of the source process template in format 'yyyy-MM-ddThh:mm:ss'.targetValidFrom
-
Valid-form (UTC) date of the target process template in format 'yyyy-MM-ddThh:mm:ss'.slice
-
Maximum number of process instances to migrate in one transaction.