|
Oracle BPEL Process Manager Client API Reference 10g Release 2 (10.1.2) B25709-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IProcessHandle
interface allows the user to introspect a BPEL process deployed on a BPEL process domain.
If this handle has been retrieved via the Locator
or IBPELDomainHandle
class, the process associated with this handle might not have been loaded successfully. In this case, most of the methods declared by this interface will not work. The list of methods that will work if the process has not been loaded is:
Field Summary |
Fields inherited from interface com.oracle.bpel.client.IBPELProcessConstants |
LIFECYCLE_ACTIVE, LIFECYCLE_RETIRED, OP_TYPE_CONTINUE_POST, OP_TYPE_CONTINUE_REQUEST, OP_TYPE_INITIAL_POST, OP_TYPE_INITIAL_REQUEST, OP_TYPE_UNDEFINED, STATE_OFF, STATE_ON |
Method Summary | |
IActivationAgentHandle |
getActivationAgentHandle(java.lang.String className) Returns a handle to the activation agent registered for this BPEL process. |
int |
getClosedInstanceCount() Returns the number of closed instances that belong to this BPEL process. |
java.lang.String |
getContent(java.lang.String rPath) Returns the content of the embedded process file with the relative path specified by rPath . |
ProcessDescriptor |
getDescriptor() Returns the process descriptor for this BPEL process. |
java.lang.Throwable[] |
getErrors() Returns the list of errors that have been reported during the loading of this BPEL process. |
java.lang.String |
getFormContent(java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName) Returns the HTML form content for the callback page for this process. |
java.lang.String |
getInitiateFormContent(java.lang.String operationName) Returns the HTML form content for the initiation page for this process. |
java.lang.String[] |
getInitiateOperationNames() Returns the operation of the process that can initiate an instance (that is, a receive tag in the BPEL source that looks like |
BPELProcessRevisionInfo |
getLatestRevision() Returns the revision information for the most recently deployed BPEL process revision. |
int |
getOpenInstanceCount() Returns the number of open instances that belong to this BPEL process. |
int |
getOperationType(java.lang.String operationName) Returns the operation type for the given operation name. |
int |
getOperationType(java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName) Returns the operation type for the operation defined for the given partner and role. |
BPELProcessId |
getProcessId() Returns the identifier of this process. |
java.lang.String |
getProcessModel() Returns the debugger XML model of this BPEL process. |
BPELProcessRevisionInfo |
getRevision() Returns the revision information for this BPEL process. |
java.lang.String |
getSensorActionDefinitions() Returns this process's sensor action definitions. |
java.lang.String |
getSensorDefinitions() Returns this process's sensor definitions. |
java.lang.String |
getSOAPLocation() Returns the URL of the SOAP listening post for this process. |
java.lang.String[] |
getWarnings() Returns the list of warnings that have been reported during the loading of this BPEL process. |
boolean |
isDefaultRevision() Returns true if this BPEL process is the default revision. |
boolean |
isLoaded() Returns true if the BPEL process been loaded successfully (that is, without any initialization errors). |
BPELProcessRevisionInfo[] |
listAllRevisions() Returns the list of revisions deployed for this BPEL process. |
IInstanceHandle[] |
listInstances() Returns a list of active instances associated with this BPEL process. |
IInstanceHandle[] |
listInstances(int listStart, int listSize) Returns a list of active instances associated with this BPEL process. |
void |
markAsDefaultRevision() Schedules this BPEL process to be marked as the default revision. |
java.util.Map |
readFormContentAsString(java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName, Parameters req) Parses the HTML request parameters according to the format expected for this process into a series of String objects. |
java.util.Map |
readInitiateFormContentAsString(java.lang.String operationName, Parameters req) Parses the HTML request parameters according to the format expected for this process into a series of String objects. |
void |
updateDescriptor(ProcessDescriptor pd) Updates the process descriptor of the BPEL process with the values contained in the passed descriptor. |
void |
updateRevision(BPELProcessRevisionInfo info) Updates the BPEL process with the values contained in the passed revision class. |
Method Detail |
public int getOperationType(java.lang.String operationName) throws ServerException
Valid operation types are:
<receive createInstance="yes">with an optional
<reply>
<receive createInstance="yes">with a
<reply>
<receive>, <onMessage>without a
<reply>
<receive>, <onMessage>with a
<reply>
ServerException
- if there is a problem connecting to the process.public int getOperationType(java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName) throws ServerException
getOperationType( String )
for list of operation types returned.ServerException
- if there is a problem connecting to the process.public java.lang.String[] getInitiateOperationNames() throws ServerException
<receive createInstance="yes">).
ServerException
- if there is a problem connecting to the process.public boolean isLoaded()
true
if the BPEL process been loaded successfully (that is, without any initialization errors). If the process has been loaded, there may still be warnings associated with the loading process.getErrors()
, getWarnings()
public BPELProcessId getProcessId()
public java.lang.Throwable[] getErrors() throws ServerException
ServerException
- if there is a problem connecting to the process.public java.lang.String getSOAPLocation() throws ServerException
ServerException
- if there is a problem connecting to the process.public java.lang.String[] getWarnings() throws ServerException
ServerException
- if there is a problem connecting to the process.public ProcessDescriptor getDescriptor() throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public void updateDescriptor(ProcessDescriptor pd) throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process or if there is a problem updating the process.public BPELProcessRevisionInfo getRevision() throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public void updateRevision(BPELProcessRevisionInfo info) throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process or if there is a problem updating the process.public BPELProcessRevisionInfo getLatestRevision() throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public BPELProcessRevisionInfo[] listAllRevisions() throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public boolean isDefaultRevision() throws ServerException
true
if this BPEL process is the default revision. The default revision is selected if an invocation message does not specify the revision tag of the process to invoke.
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public void markAsDefaultRevision() throws ServerException
The process will not be marked as the default immediately; the action will be scheduled by the server to be performed asynchronously.
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public java.lang.String getProcessModel() throws ServerException
bpelc
tool.
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public java.lang.String getContent(java.lang.String rPath) throws ServerException
rPath
. When a process archive is generated using the bpelc
tool files may be embedded within the archive. The content of these files can be accessed using this method.
The path to access the file is the same as it is in the BPEL process archive file.
This method will throw a ServerException
if the process has not loaded successfully.
rPath
- the relative path of the fileServerException
- if there is a problem connecting to the process or if there is a problem fetching the file content.public java.lang.String getInitiateFormContent(java.lang.String operationName) throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
operationName
- the initiate operation nameServerException
- if there is a problem connecting to the process.public java.lang.String getFormContent(java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName) throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
operationName
- the initiate operation name of the BPEL receiveServerException
- if there is a problem connecting to the process.public java.util.Map readInitiateFormContentAsString(java.lang.String operationName, Parameters req) throws ServerException
String
objects.
This method will throw a ServerException
if the process has not loaded successfully.
operationName
- the initiate operation namereq
- the HTML request parametersServerException
- if there is a problem connecting to the process or parsing the request parameters.public java.util.Map readFormContentAsString(java.lang.String partnerLinkName, java.lang.String roleName, java.lang.String operationName, Parameters req) throws ServerException
String
objects.
This method will throw a ServerException
if the process has not loaded successfully.
partnerLinkName
- the name of the parterLink of the BPEL receiveroleName
- the name of the role of the partnerLink of the BPEL receiveoperationName
- the initiate operation name of the BPEL receivereq
- the HTML request parametersServerException
- if there is a problem connecting to the process or parsing the request parameters.public int getOpenInstanceCount() throws ServerException
ServerException
- if there is a problem connecting to the process or if there is problem querying the domain datasource.public int getClosedInstanceCount() throws ServerException
ServerException
- if there is a problem connecting to the process or if there is problem querying the domain datasource.public IInstanceHandle[] listInstances() throws ServerException
ServerException
- if there is a problem connecting to the process or if there is problem querying the domain datasource.public IInstanceHandle[] listInstances(int listStart, int listSize) throws ServerException
listStart
specifies the starting point within the result set from the beginning (0 being the first index), and listSize
being the number of instances to return starting from the starting index.listStart
- the starting point within the result set.listSize
- the total number of items to return.ServerException
- if there is a problem connecting to the process or if there is problem querying the domain datasource.public IActivationAgentHandle getActivationAgentHandle(java.lang.String className) throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
className
- the class name of the activation agent as specified in the BPEL process descriptor.ServerException
- if there is a problem connecting to the process or if the specified activation agent has not been registered with the process.public java.lang.String getSensorDefinitions() throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.public java.lang.String getSensorActionDefinitions() throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the process.
|
Oracle BPEL Process Manager Client API Reference 10g Release 2 (10.1.2) B25709-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |