ProcessRuntimeMBean Interface

com.bea.wli.management.runtime
ProcessRuntimeMBean Interface

public interface ProcessRuntimeMBean

    extends RuntimeMBean

MBean for accessing runtime information about processes. There is one ProcessRuntimeMBean instance for all processes.


All Superinterfaces
DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

Field Summary

public static final long
CACHING_STUB_SVUID
The magic number that is used to generate the serialVersionUID of the generated MBean Stub (xxxMBean_Stub).
 

Method Summary

public ChildInstance[]
getChildProcessDataFromTracking(String parentProcessInstance)
Returns information on child process instances called by given process instance
public int
getCount(ProcessInstanceQuery query)
Returns the number of instances that satisfy the given query.
public ProcessVariableValue
getInitialMessage(String serviceURI, String instanceId)
Returns the message which started a process, or null if the process was not started by an incoming message.
public String
getLabel(String instanceId)
Returns the current value of a process's label.
public ParentInstance[]
getParentProcessDataFromTracking(String childProcessInstance)
Returns information on parent process instance that called the given process instance
public ProcessNodeInfo[]
getPendingActivities(String serviceURI, String instanceId)
Returns an array of nodes where an instance is currently blocked
public WrappedThrowable[]
getProcessExceptions(String processURI, String instanceID)
Returns a list of fatal exception for the instance.
public ProcessInstanceInfo
getProcessInstanceInfo(String id, boolean includeDetails)
Returns information about a process instance.
public List
getProcessInstanceInfo(String[] ids)
Returns information about the given process instances
public ProcessInstanceQueryResult
getProcessInstances(ProcessInstanceQuery query)
Returns ids of process instances that satisfy the given query embedded in the ProcessInstanceQueryResult object.
public ProcessVariableValue
getProcessVariable(String serviceURI, String instanceId, String variableName)
Gets the current value of a process variable
public ProcessStatistics
getStatistics(String serviceURI, long minStartTime, long maxStartTime, boolean onlyActiveInstances)
Returns statistics for a process type.
public ProcessStatistics[]
getStatistics()
Returns statistics for all process types for which there is at least one record in the summary table.
public ProcessStatus
getStatus(String instanceId)
Returns the status of an instance.
public Map
getVariableSummary(String serviceURI, String instanceId)
Returns summary values for process variables.
public void
resume(String serviceURI, String instanceId)
Resumes a suspended process instance
public void
suspend(String serviceURI, String instanceId)
Suspends a process instance
public void
terminate(String serviceURI, String instanceId)
Terminates a process instance
public void
unfreeze(String serviceURI, String instanceId)
Unfreezes a frozen instance
 
Methods from interface javax.management.DynamicMBean
getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes
 
Methods from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister
 
Methods from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener
 
Methods from interface weblogic.management.runtime.RuntimeMBean
preDeregister
 
Methods from interface weblogic.management.WebLogicMBean
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent
   

Field Detail

CACHING_STUB_SVUID

public static final long CACHING_STUB_SVUID
The magic number that is used to generate the serialVersionUID of the generated MBean Stub (xxxMBean_Stub). You must change this value whenever you make one of the changes to this interface:

- remove an existing method.
- change the signature of an existing "getter" or "setter" method.
- change the signature of an existing "boolean getter", i.e, "boolean isEnabled()"

Otherwise you don't need to change this value. For instance you can add new methods, or you can change the signature of methods that don't start with "get", "set" or "is". If you are in doubt then change the SVUID. It is a good idea to increment this value when changing.

 

Method Detail

getChildProcessDataFromTracking(String) Method

public ChildInstance[] getChildProcessDataFromTracking(String parentProcessInstance)
throws MBeanException
Returns information on child process instances called by given process instance

Exceptions

MBeanException

getCount(ProcessInstanceQuery) Method

public int getCount(ProcessInstanceQuery query)
throws MBeanException
Returns the number of instances that satisfy the given query. If the query is too expensive to execute or the number of instances is unknown, simply returns -1.

Exceptions

MBeanException

getInitialMessage(String, String) Method

public ProcessVariableValue getInitialMessage(String serviceURI, 
                                              String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessNotFoundException, ProcessInstanceNotFoundException
Returns the message which started a process, or null if the process was not started by an incoming message.

Parameters

serviceURI
service URI of the process
instanceId
id of the process instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessNotFoundException
ProcessInstanceNotFoundException

getLabel(String) Method

public String getLabel(String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessInstanceNotFoundException
Returns the current value of a process's label.

Parameters

instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessInstanceNotFoundException

getParentProcessDataFromTracking(String) Method

public ParentInstance[] getParentProcessDataFromTracking(String childProcessInstance)
throws MBeanException
Returns information on parent process instance that called the given process instance

Exceptions

MBeanException

getPendingActivities(String, String) Method

public ProcessNodeInfo[] getPendingActivities(String serviceURI, 
                                            String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessNotFoundException, ProcessInstanceNotFoundException
Returns an array of nodes where an instance is currently blocked

Parameters

serviceURI
service URI for the process
instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessNotFoundException
ProcessInstanceNotFoundException

getProcessExceptions(String, String) Method

public WrappedThrowable[] getProcessExceptions(String processURI, 
                                             String instanceID)
throws MBeanException
Returns a list of fatal exception for the instance. Usually just one.

Exceptions

MBeanException

getProcessInstanceInfo(String, boolean) Method

public ProcessInstanceInfo getProcessInstanceInfo(String id, 
                                                  boolean includeDetails)
throws MBeanException
Returns information about a process instance.

Parameters

id
the id of the process instance.
includeDetails
whether to include detailed information in the result. The detail information consists of variable values, pending activities, and initial message.

Returns

information about the given instance. Returns null if no information could be found for the given instance

Exceptions

MBeanException

getProcessInstanceInfo(String[]) Method

public List getProcessInstanceInfo(String[] ids)
throws MBeanException
Returns information about the given process instances

Parameters

ids
an array of process instance ids

Returns

a List of ProcessInstanceInfo objects. The result could have less element than the number of instance ids. This happens If no information could be found for an instance.

Exceptions

MBeanException

getProcessInstances(ProcessInstanceQuery) Method

public ProcessInstanceQueryResult getProcessInstances(ProcessInstanceQuery query)
throws MBeanException
Returns ids of process instances that satisfy the given query embedded in the ProcessInstanceQueryResult object.

Exceptions

MBeanException

getProcessVariable(String, String, String) Method

public ProcessVariableValue getProcessVariable(String serviceURI, 
                                               String instanceId, 
                                               String variableName)
throws MBeanException, ConversationNotFoundException, NoSuchFieldException, ProcessInstanceNotFoundException, ProcessNotFoundException
Gets the current value of a process variable

Parameters

serviceURI
service URI of the process
instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
NoSuchFieldException
ProcessInstanceNotFoundException
ProcessNotFoundException

getStatistics(String, long, long, boolean) Method

public ProcessStatistics getStatistics(String serviceURI, 
                                       long minStartTime, 
                                       long maxStartTime, 
                                       boolean onlyActiveInstances)
throws MBeanException
Returns statistics for a process type.

Parameters

serviceURI
the service URI for the process
minStartTime
include only instances that have started after this time. Use 0 if this is not applicable to the filtering criteria.
maxStartTime
include only instances that have started before this time. Use Long.MAX_VALUE if this is not applicable ot the filtering criteria.
onlyActiveInstances
include only active instances, namely instances that are running, suspended, or frozen. if false all instances are considered.

Exceptions

MBeanException

getStatistics() Method

public ProcessStatistics[] getStatistics()
throws MBeanException
Returns statistics for all process types for which there is at least one record in the summary table. If there is no record of an instance of a particular process type (perhaps because no instance of that process has ever run since the last archive and purge process) then no statistics is returned for that process type.

Returns

an array of ProcessStatistics objects one for each process type.

Exceptions

MBeanException

getStatus(String) Method

public ProcessStatus getStatus(String instanceId)
throws MBeanException
Returns the status of an instance.

Parameters

instanceId
the id of the instance

Exceptions

MBeanException

getVariableSummary(String, String) Method

public Map getVariableSummary(String serviceURI, 
                              String instanceId)
throws ProcessInstanceNotFoundException, ProcessNotFoundException, MBeanException
Returns summary values for process variables. The result is a map from variable names (String) to ProcessVariableValue containins a short string representation of the value.

Parameters

serviceURI
service URI of the process
instanceId
id of the instance

Exceptions

ProcessInstanceNotFoundException
when the given instance was not found
ProcessNotFoundException
when the given process is not found
MBeanException
any other exception is wrapped with a ManagementException

resume(String, String) Method

public void resume(String serviceURI, 
                   String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessNotFoundException, ProcessInstanceNotFoundException
Resumes a suspended process instance

Parameters

serviceURI
service URI for the process
instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessNotFoundException
ProcessInstanceNotFoundException

suspend(String, String) Method

public void suspend(String serviceURI, 
                    String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessInstanceNotFoundException, ProcessNotFoundException
Suspends a process instance

Parameters

serviceURI
service URI for the process
instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessInstanceNotFoundException
ProcessNotFoundException

terminate(String, String) Method

public void terminate(String serviceURI, 
                      String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessNotFoundException, ProcessInstanceNotFoundException
Terminates a process instance

Parameters

serviceURI
service URI for the process
instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessNotFoundException
ProcessInstanceNotFoundException

unfreeze(String, String) Method

public void unfreeze(String serviceURI, 
                     String instanceId)
throws MBeanException, ConversationNotFoundException, ProcessNotFoundException, ProcessInstanceNotFoundException
Unfreezes a frozen instance

Parameters

serviceURI
service URI for the process
instanceId
the id of the instance

Exceptions

MBeanException
ConversationNotFoundException
ProcessNotFoundException
ProcessInstanceNotFoundException