|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
public interface BPELManagementService
Defines operations for managing BPEL process instances
| Nested Class Summary | |
|---|---|
static class |
BPELManagementService.ActivityStatus
Encapsulates the Activity status and runtime information |
static class |
BPELManagementService.BPInstanceInfo
Encapsulates BPEL instance runtime information |
static class |
BPELManagementService.BPInstanceQueryResult
The Query Result wrapper class containing the return list and data of the return batch |
static class |
BPELManagementService.BPStatus
Encapsulates the BPEL instance status |
static class |
BPELManagementService.SortColumn
An Enum class for valid sort parameter values |
static class |
BPELManagementService.SortOrder
An Enum class for valid order parameter values |
static class |
BPELManagementService.VarInfo
Encapsulates BPEL variable information |
| Method Summary | |
|---|---|
boolean |
changeVariableValue(java.lang.String instanceId,
long varId,
java.lang.String partName,
java.lang.String xpath,
java.lang.String value,
java.lang.String target)
Change BPEL variable value, only the leaf node can be changed Only available when isMonitoringVariableEnabled returns true. |
java.util.List<BPELManagementService.ActivityStatus> |
getBPELInstanceActivityStatus(java.lang.String instanceId,
java.lang.String target)
Get the list of ActivityStatus of a BPEL instance |
java.lang.String |
getBPELInstanceFault(java.lang.String instanceId,
java.lang.String target)
Get the fault detail of a faulted bpel instance; |
BPELManagementService.BPInstanceQueryResult |
getBPELInstances(java.lang.String bpelQName,
BPELManagementService.BPStatus status,
java.lang.String instanceId,
java.lang.Integer maxRecords,
BPELManagementService.SortColumn sortColumn,
BPELManagementService.SortOrder order,
java.lang.String target)
Get BPEL instances given optional BPEL process QName and/or an optional BPStatus or an optional instance id If instanceid is present, the BPEL process QName and BPStatus are ignored |
java.util.List<java.lang.String> |
getBPELProcessIds(java.lang.String suName,
java.lang.String target)
Get the list of BPEL process QName as String within an SU. |
java.util.List<BPELManagementService.BPInstanceInfo> |
getInvokeeInstance(java.lang.String instanceId,
java.lang.Long invokeActivityId,
java.lang.String target)
Get the list of invokee (sub) bpel instance(s) that a specific bpel instance invoked. |
java.util.List<BPELManagementService.BPInstanceInfo> |
getInvokerInstance(java.lang.String instanceId,
java.lang.Long receiveActivityId,
java.lang.String target)
Get the list of invoker (parent) bpel instance(s) that invoked a specific bpel instance. |
java.lang.String |
getVariableValue(java.lang.String instanceId,
long varId,
java.lang.String target)
Get the BPEL variable value, the content of BPEL variable will be returned Only available when isMonitoringVariableEnabled returns true. |
boolean |
isMonitoringEnabled(java.lang.String target)
Is Monitoring enabled |
boolean |
isMonitoringVariableEnabled(java.lang.String target)
Is Monitoring Variable Enabled. |
boolean |
isPersistenceEnabled(java.lang.String target)
Is persistence enabled |
java.util.List<BPELManagementService.VarInfo> |
listBPELVaraibles(java.lang.String instanceId,
java.lang.String varName,
java.lang.String target)
Get the BPEL variable info for a bpel instance Only available when isMonitoringVariableEnabled returns true. |
java.util.List<java.lang.String> |
resumeAllInstance(java.lang.String processName,
java.lang.String target)
Resume all instances of a bpel process |
boolean |
resumeInstance(java.lang.String instanceId,
java.lang.String target)
Resume a suspended BPEL instance |
BPELManagementService.BPInstanceQueryResult |
searchBPELInstances(java.lang.String bpelQName,
BPELManagementService.BPStatus status,
java.lang.String searchString,
java.lang.Integer maxRecords,
BPELManagementService.SortColumn sortColumn,
BPELManagementService.SortOrder order,
java.lang.String target)
Search for BPEL instances info given BPEL process QName and a SearchString and/or an optional BPStatus. |
java.util.List<java.lang.String> |
suspendAllInstance(java.lang.String processName,
java.lang.String target)
Suspend all instances of a bpel process |
boolean |
suspendInstance(java.lang.String instanceId,
java.lang.String target)
Suspend BPEL instance |
java.util.List<java.lang.String> |
terminateAllInstance(java.lang.String processName,
java.lang.String target)
Terminate all instances of a bpel process |
boolean |
terminateInstance(java.lang.String instanceId,
java.lang.String target)
Terminate a BPEL instance |
| Method Detail |
|---|
boolean isMonitoringEnabled(java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
target - If null, it is not in a clustered, if not null, it is the target name of a cluster
com.sun.caps.management.common.ManagementRemoteException
boolean isMonitoringVariableEnabled(java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
target - If null, it is not in a clustered, if not null, it is the target name of a cluster
com.sun.caps.management.common.ManagementRemoteException
boolean isPersistenceEnabled(java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
target - If null, it is not in a clustered, if not null, it is the target name of a cluster
com.sun.caps.management.common.ManagementRemoteException
java.util.List<java.lang.String> getBPELProcessIds(java.lang.String suName,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
suName - The name of the SU.target - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.util.List<BPELManagementService.ActivityStatus> getBPELInstanceActivityStatus(java.lang.String instanceId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - target - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
BPELManagementService.BPInstanceQueryResult getBPELInstances(java.lang.String bpelQName,
BPELManagementService.BPStatus status,
java.lang.String instanceId,
java.lang.Integer maxRecords,
BPELManagementService.SortColumn sortColumn,
BPELManagementService.SortOrder order,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
Without max specified, the maximum instances to return is 1000, user specifies a number for maxRecords to limit the number
of the instances returned.
If the BPInstanceQueryResult.overflow is true, it indicates the number of qualifying instances is larger than 1000,
no instances are returned in the result list, user should specify a maxRecords
and sortColumn and order
target - If null, it is not in a clustered, if not null, it is the target name of a clusterbpelQName - BPEL process QName as String, not used if instanceId is presentstatus - Optional, if present, only the instances of the specific status are returned, not used if instanceId is presentinstanceId - Optional, if present only the specific instance is returnedmaxRecords - OptionalsortColumn - OptionalSortOrder - Optional
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
BPELManagementService.BPInstanceQueryResult searchBPELInstances(java.lang.String bpelQName,
BPELManagementService.BPStatus status,
java.lang.String searchString,
java.lang.Integer maxRecords,
BPELManagementService.SortColumn sortColumn,
BPELManagementService.SortOrder order,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
maxRecords to limit the number
of the instances returned.
If the BPInstanceQueryResult.overflow is true, it indicates the number of qualifying instances is larger than 1000,
no instances are returned in the result list, user should specify a maxRecords
and sortColumn and order
target - If null, it is not in a clustered, if not null, it is the target name of a clusterbpelQName - BPEL process QName as String, not used if instanceId is presentstatus - Optional, if present, only the instances of the specific status are returned.searchString - The searchStringmaxRecords - OptionalsortColumn - OptionalSortOrder - Optional
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.lang.String getBPELInstanceFault(java.lang.String instanceId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - the faulted bpel instance idtarget - If null, it is not in a clustered, if not null, it is the target name of a clusterconn - database connection, when the result is obtained, the conn is closed.
com.sun.caps.management.common.ManagementRemoteException
java.util.List<BPELManagementService.BPInstanceInfo> getInvokerInstance(java.lang.String instanceId,
java.lang.Long receiveActivityId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
Only available when isMonitoringVariableEnabled returns true. If isMonitoringVariableEnabled return false, exception will be thrown
instanceId - The invoked bpel instance idreceiveActivityId - Optional receive activity id of the invoked bpel instance, if present, returns only one invoker bpel instance that sends msg to the specific receivetarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.util.List<BPELManagementService.BPInstanceInfo> getInvokeeInstance(java.lang.String instanceId,
java.lang.Long invokeActivityId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
Only available when isMonitoringVariableEnabled returns true. If isMonitoringVariableEnabled return false, exception will be thrown
instanceId - The invoked bpel instance idinvokeActivityId - Optional invoke activity id of the invoker bpel instance, if present,
returns the only one invokee bpel instance that receives msg from the specific invoketarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
boolean suspendInstance(java.lang.String instanceId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - The bpel instance to be suspendedtarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.util.List<java.lang.String> suspendAllInstance(java.lang.String processName,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
processName - The process name (QName)target - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
boolean resumeInstance(java.lang.String instanceId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - The bpel instance to be resumedtarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.util.List<java.lang.String> resumeAllInstance(java.lang.String processName,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
processName - The process name (QName)target - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
boolean terminateInstance(java.lang.String instanceId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - The bpel instance to be terminatedtarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.util.List<java.lang.String> terminateAllInstance(java.lang.String processName,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
processName - The process name (QName)target - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
boolean changeVariableValue(java.lang.String instanceId,
long varId,
java.lang.String partName,
java.lang.String xpath,
java.lang.String value,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - The instance id of the instance on which the variable will be changedvarId - The variable Id, can not be nullpartName - The part name of the variable, if null, the variable is not message typexpath - The xpath leading to the leaf node to be changed, if null, the whole variable part (if message type) or variable (not message type) is to changevalue - The new value to changetarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.lang.String getVariableValue(java.lang.String instanceId,
long varId,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - The instance id of the instancevarId - The variable Id, can not be nulltarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
java.lang.Exception
com.sun.caps.management.common.ManagementRemoteException
java.util.List<BPELManagementService.VarInfo> listBPELVaraibles(java.lang.String instanceId,
java.lang.String varName,
java.lang.String target)
throws com.sun.caps.management.common.ManagementRemoteException
instanceId - The instance id of the instancevarName - Optional, if specified, only returns the info for the variable of this nametarget - If null, it is not in a clustered, if not null, it is the target name of a cluster
com.sun.caps.management.common.ManagementRemoteException
|
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||