|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface BpelManagementFacade
Instance management interaction interface. Instance management is a broad concept that covers instance introspection, debugging, and monitoring. This interface allows external systems to perform these functions.
NOTE: this interface is not currently intended to be published. It is currently used by the higher-level debugging facility.
| Method Summary | |
|---|---|
ActivityBreakpoint |
addActivityBreakpoint(java.lang.Long iid,
java.lang.String activity)
Adds an activity breakpoint. |
ActivityBreakpoint |
addGlobalActivityBreakpoint(java.lang.String procId,
java.lang.String activity)
Adds an global activity breakpoint. |
VariableModificationBreakpoint |
addVariableModificationBreakpoint(java.lang.Long iid,
java.lang.String scopeName,
java.lang.String variable)
Adds a variable modification breakpoint. |
Breakpoint[] |
getBreakpoints(java.lang.Long iid)
Returns the breakpoints registered with the process instance. |
javax.xml.namespace.QName |
getCompletedFault(java.lang.Long iid)
Gets the fault associated with a completed process instance. |
CorrelationKey |
getCorrelation(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String correlationSet)
Gets a correlation. |
int |
getEventCount(java.lang.Long iid)
Get the current number of events for an instance. |
org.apache.ode.bpel.pmapi.EventInfoListDocument |
getEvents(java.lang.Long iid,
int startIdx,
int count)
Get exeuction event history for a process instance. |
Breakpoint[] |
getGlobalBreakpoints(java.lang.String procId)
Returns the global breakpoints registered with the process instance. |
org.apache.ode.bpel.o.OProcess |
getProcessDef(java.lang.String procId)
Return the process model. |
java.lang.Long |
getProcessInstance(java.lang.String pid,
CorrelationKey ckey)
Get the process instance with the given correlation correlationKey. |
java.lang.Long[] |
getScopeInstancesForScope(java.lang.Long iid,
java.lang.String scopeName)
Returns all the scope instance ids for a given instance and scope name. |
java.util.Date |
getStartTime(java.lang.Long iid)
Get the time that a process instance was started (created). |
short |
getState(java.lang.Long iid)
Get the state of a process instance. |
java.lang.String |
getVariable(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String varName)
Gets variable data. |
void |
removeBreakpoint(java.lang.Long iid,
Breakpoint sp)
Removes a breakpoint |
void |
removeGlobalBreakpoint(java.lang.String procId,
Breakpoint sp)
Removes a global breakpoint |
void |
setCorrelation(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String correlationSet,
javax.xml.namespace.QName[] propertyNames,
CorrelationKey values)
Sets a correlation. |
void |
setVariable(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String varName,
java.lang.String data)
Sets a variable |
void |
step(java.lang.Long iid)
Single step through a process instance. |
| Methods inherited from interface org.apache.ode.bpel.pmapi.ProcessManagement |
|---|
activate, getExtensibilityElements, getProcessInfo, getProcessInfoCustom, listAllProcesses, listProcesses, listProcessesCustom, listProcessesSummaryOnly, setPackageRetired, setProcessProperty, setProcessPropertyNode, setRetired |
| Methods inherited from interface org.apache.ode.bpel.pmapi.InstanceManagement |
|---|
delete, fault, getEventTimeline, getInstanceInfo, getScopeInfo, getScopeInfoWithActivity, getVariableInfo, listAllInstances, listAllInstancesWithLimit, listEvents, listInstances, listInstancesSummary, queryInstances, recoverActivity, resume, suspend, terminate |
| Method Detail |
|---|
java.util.Date getStartTime(java.lang.Long iid)
throws ManagementException
iid - process instance identifier
ManagementException
short getState(java.lang.Long iid)
throws ManagementException
iid - process instance identifier
ManagementException
java.lang.Long getProcessInstance(java.lang.String pid,
CorrelationKey ckey)
throws ManagementException
pid - the process identifierckey - the correlation correlationKey to match
ManagementException
org.apache.ode.bpel.pmapi.EventInfoListDocument getEvents(java.lang.Long iid,
int startIdx,
int count)
throws ManagementException
iid - process instance identifierstartIdx - first evetcount - maximum number of events to get
ProcessInstanceEvents.
ManagementException
int getEventCount(java.lang.Long iid)
throws ManagementException
iid - process instance identifier
ManagementException
java.lang.Long[] getScopeInstancesForScope(java.lang.Long iid,
java.lang.String scopeName)
throws ManagementException
ManagementException
java.lang.String getVariable(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String varName)
throws ManagementException
iid - scopeId - varName -
ManagementException
void setVariable(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String varName,
java.lang.String data)
iid - scopeId - varName - data -
void setCorrelation(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String correlationSet,
javax.xml.namespace.QName[] propertyNames,
CorrelationKey values)
throws ManagementException
iid - scopeId - correlationSet - name of the correlation setpropertyNames - properties to set on correlation setvalues - property values as a CorrelationKey object
ManagementException
CorrelationKey getCorrelation(java.lang.Long iid,
java.lang.Long scopeId,
java.lang.String correlationSet)
throws ManagementException
iid - scopeId - correlationSet -
ManagementException
org.apache.ode.bpel.o.OProcess getProcessDef(java.lang.String procId)
throws ManagementException
procId -
ManagementException
void step(java.lang.Long iid)
throws ManagementException
iid -
ManagementException
javax.xml.namespace.QName getCompletedFault(java.lang.Long iid)
throws ManagementException
iid -
ManagementException
Breakpoint[] getBreakpoints(java.lang.Long iid)
throws ManagementException
iid - process instance identifier
Breakpoints.
ManagementException
Breakpoint[] getGlobalBreakpoints(java.lang.String procId)
throws ManagementException
procId -
Breakpoints.
ManagementException
void removeBreakpoint(java.lang.Long iid,
Breakpoint sp)
throws ManagementException
iid - a iid of null removes a global breakpoint.sp -
ManagementException
void removeGlobalBreakpoint(java.lang.String procId,
Breakpoint sp)
throws ManagementException
procId - sp -
ManagementException
ActivityBreakpoint addActivityBreakpoint(java.lang.Long iid,
java.lang.String activity)
throws ManagementException
iid - a iid of null adds a global activity breakpoint.activity -
ManagementException
ActivityBreakpoint addGlobalActivityBreakpoint(java.lang.String procId,
java.lang.String activity)
throws ManagementException
procId - activity -
ManagementException
VariableModificationBreakpoint addVariableModificationBreakpoint(java.lang.Long iid,
java.lang.String scopeName,
java.lang.String variable)
iid - scopeName - variable -
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||