|
Oracle BPEL Process Manager Client Java API Reference 10g Release 3 (10.1.3.1.0) B28986-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IBPELDomainHandle
The IBPELDomainHandle
interface allows the developer to perform operations on a running BPEL process domain. The BPEL process domain hosts BPEL processes and provides the necessary run-time services needed to initiate and complete instances of BPEL processes.
The process domain supports versioning for deployed BPEL processes. A BPEL process may be deployed multiple times under different revision tags. However, only the most recent revision may be used to instantiate new instances (these process revisions are called "open"); active instances belonging to older revisions are permitted to complete normally.
Method Summary | |
---|---|
int |
cancelCallbackMessages(java.lang.String[] messageGUIDs) Marks a list of callback messages as cancelled by the BPEL domain. |
int |
cancelInvokeMessages(java.lang.String[] messageGUIDs) Marks a list of invocation messages as cancelled by the BPEL domain. |
void |
changePassword(java.lang.String newPassword) Changes the password for the process domain. |
void |
clearAllProcessEvents() |
void |
clearProcessEvents(BPELProcessId processId) |
void |
clearStatistics() Clears the current set of statistics gathered by the process domain (includes synchronous, asynchronous and request). |
void |
clearWSDLCache() Clear all the WSDLs cached in the WSDL manager of this domain. |
int |
deleteAllInstances() Deletes all the instances contained in the process domain. |
int |
deleteCallbackMessages(java.lang.String[] messageGUIDs) Deletes a list of callback messages from the BPEL domain. |
int |
deleteInstancesByProcessId(BPELProcessId processId) Deletes all the instances contained in the process domain for the specified BPEL process. |
int |
deleteInvokeMessages(java.lang.String[] messageGUIDs) Deletes a list of invocation messages from the BPEL domain. |
void |
deployProcess(java.io.File f) Deprecated. since 10.1.3, use deploySuitcase( File ) |
void |
deployProcess(java.io.InputStream is, java.lang.String fileName) Deprecated. since 10.1.3, use deploySuitcase( InputStream ) |
void |
deploySuitcase(java.io.File f) |
void |
deploySuitcase(java.io.InputStream is) |
int |
getActiveProcessCount() Returns the number of open processes that have been deployed to this process domain. |
Statistics[] |
getAsyncStatistics() Returns a list of statistics regarding the process domain's performance with asynchronous instances. |
java.lang.String |
getCallbackContent(java.lang.String messageGUID) Returns the callback message with the specified message GUID. |
int |
getClosedInstanceCount() Returns the number of closed instances that belong to this process domain. |
com.oracle.bpel.client.config.BPELDomainDescriptor |
getDescriptor() Returns the domain descriptor for this BPEL domain. |
java.lang.String |
getDispatcherTrace() Returns an XML dump of the current messages contained in the BPEL server's dispatcher. |
java.lang.String |
getDomainId() Returns the identifier of the process domain. |
java.lang.String |
getHomeDir() Returns the absolute path to the directory where the process domain is installed. |
java.lang.String |
getInvokeContent(java.lang.String messageGUID) Returns the invocation message with the specified message GUID. |
java.lang.String |
getLogContent(java.lang.String logFileName, int lastN) Returns the last lastN lines of the specified log file for this BPEL domain. |
int |
getOpenInstanceCount() Returns the number of open instances that have been created in this process domain. |
java.util.Map |
getProperties() Returns the properties contained in the domain descriptor configuration file. |
Statistics[] |
getRequestStatistics() Returns a list of statistics regarding the process domain's performance for individual requests. |
int |
getRetiredProcessCount() Returns the number of closed processes that have been deployed to this process domain. |
byte[] |
getSuitcase(java.lang.String suitcaseId) |
Statistics[] |
getSyncStatistics() performance with synchronous instances. |
java.lang.String |
getXMLDocument(java.lang.String dockey) |
IBPELProcessHandle[] |
listActiveProcesses() Returns a list of all the open (those processes that can instantiate new instances) processes that have been deployed to the process domain. |
LogFileInfo[] |
listLogFiles() Returns list of log files used by the BPEL domain to log error/debug/informational messages. |
java.util.Map |
listLoggers() Returns a list of all the loggers defined for the domain. |
IBPELProcessHandle[] |
listProcesses() Returns a list of all the processes that have been deployed to the process domain. |
void |
logProcessEvent(BPELProcessEvent event) Logs an event for a process deployed on this BPEL domain. |
void |
pingDispatcher() Pings the dispatcher by sending no-op message to the engine dispatcher. |
int |
recoverActivities(java.lang.String[] correlationIds) Schedules a list of activities to be recovered by the BPEL domain. |
int |
recoverCallbackMessages(java.lang.String[] messageGUIDs) Schedules a list of callback messages to be recovered by the BPEL domain. |
int |
recoverInvokeMessages(java.lang.String[] messageGUIDs) Schedules a list of invocation messages to be recovered by the BPEL domain. |
void |
refreshAlarmTable() |
void |
undeployProcess(BPELProcessId processId) Undeploys an existing process from the BPEL process domain. |
void |
updateDescriptor(com.oracle.bpel.client.config.BPELDomainDescriptor dd) Updates the domain descriptor of the BPEL domain with the values contained in the passed descriptor. |
void |
updateLoggers(java.util.Map levels) Updates the loggers defined for the BPEL domain with the specified logging levels. |
Method Detail |
---|
java.lang.String getDomainId()
java.lang.String getHomeDir() throws ServerException
ServerException
- if there is a problem connecting to the domain.java.util.Map getProperties() throws ServerException
ServerException
void changePassword(java.lang.String newPassword) throws ServerException
oldPassword
- the existing process domain passwordnewPassword
- the new process domain passwordServerException
- if there is a problem connecting to the domain or if the old password supplied is incorrect.com.oracle.bpel.client.config.BPELDomainDescriptor getDescriptor() throws ServerException
ServerException
- if there is a problem connecting to the domain.void updateDescriptor(com.oracle.bpel.client.config.BPELDomainDescriptor dd) throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem updating the domain.java.util.Map listLoggers() throws ServerException
Map
with the logger name as the key and the current logger level as a String
.ServerException
- if there is a problem connecting to the domain.void updateLoggers(java.util.Map levels) throws ServerException
levels
- Map
with the logger name as the key and the desired logger level as a String
.ServerException
- if there is a problem connecting to the domain or if there is problem updating the loggers defined for the domain.LogFileInfo[] listLogFiles() throws ServerException
ServerException
- if there is a problem connecting to the domain.java.lang.String getLogContent(java.lang.String logFileName, int lastN) throws ServerException
lastN
lines of the specified log file for this BPEL domain. Access is only granted to log files residing in the BPEL domain's log directory; absolute and relative paths will not be resolved.logFileName
- the name of the log file to accesslastN
- the number of lines starting from the end of the file to return.ServerException
- if there is problem connecting to the domain or if the log file could not be found/resolved.void logProcessEvent(BPELProcessEvent event) throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem logging the event with the domain.void clearProcessEvents(BPELProcessId processId) throws ServerException
ServerException
void clearAllProcessEvents() throws ServerException
ServerException
int getActiveProcessCount() throws ServerException
ServerException
- if there is a problem connecting to the domain.int getRetiredProcessCount() throws ServerException
ServerException
- if there is a problem connecting to the domain.IBPELProcessHandle[] listProcesses() throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of processes from the domain.IBPELProcessHandle[] listActiveProcesses() throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of processes from the domain.void deploySuitcase(java.io.InputStream is) throws ServerException
ServerException
void deployProcess(java.io.InputStream is, java.lang.String fileName) throws ServerException
deploySuitcase( InputStream )
is
- the bytes composing the BPEL archivefileName
- the name to save the BPEL archive as in the domain deployment directory.ServerException
- if there is a problem connecting to the domain or if there is a problem deploying the process to the domain.void deploySuitcase(java.io.File f) throws ServerException
ServerException
void deployProcess(java.io.File f) throws ServerException
deploySuitcase( File )
ServerException
void undeployProcess(BPELProcessId processId) throws ServerException
The undeployment operation is performed asynchronously so calling this method may not result in immediate undeployment.
processId
- the BPEL process identifierServerException
- if there is a problem connecting to the domain or if there is a problem undeploying the process from the domain.int deleteAllInstances() throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem deleting the instances from the domain.int deleteInstancesByProcessId(BPELProcessId processId) throws ServerException
processId
- the BPEL process identifierServerException
- either one of the following errors:
int getOpenInstanceCount() throws ServerException
ServerException
- if there is a problem connecting to the domain.int getClosedInstanceCount() throws ServerException
ServerException
- if there is a problem connecting to the domain.Statistics[] getSyncStatistics() throws ServerException
Each set of statistics details the domain's performance for one synchronous process (that is, minimum and maximum performance times). These statistics are constantly updated with each completed synchronous instances serviced by the domain.
ServerException
- if there is a problem connecting to the domain.Statistics[] getAsyncStatistics() throws ServerException
Each set of statistics details the domain's performance for one asynchronous process (that is, minimum and maximum performance times). These statistics are constantly updated with each completed asynchronous instances serviced by the domain.
ServerException
- if there is a problem connecting to the domain.Statistics[] getRequestStatistics() throws ServerException
Each set of statistics details the domain's performance for one operation (for instance, loading the instance from the database). These statistics are constantly updated with each request serviced by the domain.
ServerException
- if there is a problem connecting to the domain.void clearStatistics() throws ServerException
ServerException
- if there is a problem connecting to the domain.java.lang.String getDispatcherTrace() throws ServerException
ServerException
- if there is a problem connecting to the domain or fetching the dispatcher trace.int recoverActivities(java.lang.String[] correlationIds) throws ServerException
correlationIds
- list of activity correlation identifiers.ServerException
- if there is a problem connecting to the domain or if there is a problem scheduling the activities to be performed.int recoverInvokeMessages(java.lang.String[] messageGUIDs) throws ServerException
messageGUIDs
- list of invoke message GUIDs.ServerException
- if there is a problem connecting to the domain or if there is a problem scheduling the messages to be resubmitted.int cancelInvokeMessages(java.lang.String[] messageGUIDs) throws ServerException
messageGUIDs
- list of invoke message GUIDs.ServerException
- if there is a problem connecting to the domain or if there is a problem marking the messages as cancelled.int deleteInvokeMessages(java.lang.String[] messageGUIDs) throws ServerException
messageGUIDs
- list of invoke message GUIDs.ServerException
- if there is a problem connecting to the domain or if there is a problem deleting the messages from the datastore.int recoverCallbackMessages(java.lang.String[] messageGUIDs) throws ServerException
messageGUIDs
- list of callback message GUIDs.ServerException
- if there is a problem connecting to the domain or if there is a problem scheduling the messages to be resubmitted.int cancelCallbackMessages(java.lang.String[] messageGUIDs) throws ServerException
messageGUIDs
- list of callback message GUIDs.ServerException
- if there is a problem connecting to the domain or if there is a problem marking the messages as cancelled.int deleteCallbackMessages(java.lang.String[] messageGUIDs) throws ServerException
messageGUIDs
- list of callback message GUIDs.ServerException
- if there is a problem connecting to the domain or if there is a problem deleting the messages from the datastore.java.lang.String getInvokeContent(java.lang.String messageGUID) throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the invocation message.java.lang.String getCallbackContent(java.lang.String messageGUID) throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the callback message.void clearWSDLCache() throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem clearing WSDLs cached in the domain.void pingDispatcher() throws ServerException
ServerException
void refreshAlarmTable() throws ServerException
ServerException
java.lang.String getXMLDocument(java.lang.String dockey) throws ServerException
ServerException
byte[] getSuitcase(java.lang.String suitcaseId) throws ServerException
ServerException
|
Oracle BPEL Process Manager Client Java API Reference 10g Release 3 (10.1.3.1.0) B28986-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |