com.oracle.bpel.client
Interface IBPELDomainHandle

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.

Since:

1.0

Method Summary

int	archiveAllInstances(boolean deleteInstances) Archives all closed instances in the process domain.
void	archiveInstance(java.lang.String referenceId, boolean deleteInstance) Archives the specified instance.
int	archiveInstances(WhereCondition wc, boolean deleteInstances) Archives all instances returned by the search condition specified by wc.
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	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.InputStream is, java.lang.String fileName) Deploys a new process to the BPEL process domain.
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	getCacheTrace() Returns an XML dump of the current cache statistics for the BPEL domain.
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.
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.
Statistics[]	getSyncStatistics() Returns a list of statistics regarding the process domain's performance with synchronous instances.
boolean	isArchivingEnabled() Returns true if at least one archive store has been defined for this process domain.
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(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

getDomainId

public java.lang.String getDomainId()

Returns the identifier of the process domain. The identifier is used to differentiate between multiple installations of Orabpel on the same application server.

getHomeDir

public java.lang.String getHomeDir()
                            throws ServerException

Returns the absolute path to the directory where the process domain is installed.

Throws:

ServerException - if there is a problem connecting to the domain.

getProperties

public java.util.Map getProperties()
                            throws ServerException

Returns the properties contained in the domain descriptor configuration file.

Throws:

ServerException

changePassword

public void changePassword(java.lang.String newPassword)
                    throws ServerException

Changes the password for the process domain.

Parameters:

newPassword - the new process domain password

Throws:

ServerException - if there is a problem connecting to the domain or if the old password supplied is incorrect.

getDescriptor

public BPELDomainDescriptor getDescriptor()
                                   throws ServerException

Returns the domain descriptor for this BPEL domain. The domain descriptor contains run-time configurable properties such as optimization flags.

Throws:

ServerException - if there is a problem connecting to the domain.

updateDescriptor

public void updateDescriptor(BPELDomainDescriptor dd)
                      throws ServerException

Updates the domain descriptor of the BPEL domain with the values contained in the passed descriptor.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem updating the domain.

listLoggers

public java.util.Map listLoggers()
                          throws ServerException

Returns a list of all the loggers defined for the domain. Currently, the BPEL server uses log4j to log error/debug/informational messages. This method will return a list of all the log4j logger names that have been defined for this domain.

Returns:

a Map with the logger name as the key and the current logger level as a String.

Throws:

ServerException - if there is a problem connecting to the domain.

updateLoggers

public void updateLoggers(java.util.Map levels)
                   throws ServerException

Updates the loggers defined for the BPEL domain with the specified logging levels. Currently, the BPEL server uses log4j to log error/debug/informational messages. The logging levels recognized by the domain are:

• OFF - highest possible rank, intended to turn off logging.
• FATAL - very severe error events that will presumably lead the process/instance to abort.
• ERROR - error events that might still allow the process/instance to continue running.
• WARN - potentially harmful situations.
• INFO - informational messages that highlight the progress of the process/instance at coarse-grained level.
• DEBUG - fine-grained informational events, most useful to debug server internals.
  ALL - lowest possible rank, intended to turn on all logging.

  Parameters:

  levels - Map with the logger name as the key and the desired logger level as a String.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is problem updating the loggers defined for the domain.

  listLogFiles

  public LogFileInfo[] listLogFiles()
                             throws ServerException
  

  Returns list of log files used by the BPEL domain to log error/debug/informational messages.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getLogContent

  public java.lang.String getLogContent(java.lang.String logFileName,
                                        int lastN)
                                 throws ServerException
  

  Returns the last 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.

  Parameters:

  logFileName - the name of the log file to access

  lastN - the number of lines starting from the end of the file to return.

  Throws:

  ServerException - if there is problem connecting to the domain or if the log file could not be found/resolved.

  logProcessEvent

  public void logProcessEvent(BPELProcessEvent event)
                       throws ServerException
  

  Logs an event for a process deployed on this BPEL domain.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem logging the event with the domain.

  getActiveProcessCount

  public int getActiveProcessCount()
                            throws ServerException
  

  Returns the number of open processes that have been deployed to this process domain. A process is open if it can instantiate new instances.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getRetiredProcessCount

  public int getRetiredProcessCount()
                             throws ServerException
  

  Returns the number of closed processes that have been deployed to this process domain. A process is closed if it cannot instantiate new instances; however, instances that have already been instantiated may complete normally.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  listProcesses

  public IBPELProcessHandle[] listProcesses()
                                     throws ServerException
  

  Returns a list of all the processes that have been deployed to the process domain. This list will include both closed (those processes that cannot instantiate new instances), open (those processes that can instantiate new instances) and erroneous (those processes that did not load properly due to an initialization error).

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem fetching the list of processes from the domain.

  listActiveProcesses

  public IBPELProcessHandle[] listActiveProcesses()
                                           throws ServerException
  

  Returns a list of all the open (those processes that can instantiate new instances) processes that have been deployed to the process domain.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem fetching the list of processes from the domain.

  deployProcess

  public void deployProcess(java.io.InputStream is,
                            java.lang.String fileName)
                     throws ServerException
  

  Deploys a new process to the BPEL process domain.

  Parameters:

  is - the bytes composing the BPEL archive

  fileName - the name to save the BPEL archive as in the domain deployment directory.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem deploying the process to the domain.

  undeployProcess

  public void undeployProcess(BPELProcessId processId)
                       throws ServerException
  

  Undeploys an existing process from the BPEL process domain. Existing instances (both open and closed) will be marked as stale once the process has been undeployed. It is advised that the user change the mode of the process to closed and allowing open instances a chance to complete before undeployment.

  The undeployment operation is performed asynchronously so calling this method may not result in immediate undeployment.

  Parameters:

  processId - the BPEL process identifier

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem undeploying the process from the domain.

  deleteAllInstances

  public int deleteAllInstances()
                         throws ServerException
  

  Deletes all the instances contained in the process domain.

  Returns:

  the number of instances successfully deleted

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem deleting the instances from the domain.

  deleteInstancesByProcessId

  public int deleteInstancesByProcessId(BPELProcessId processId)
                                 throws ServerException
  

  Deletes all the instances contained in the process domain for the specified BPEL process.

  Parameters:

  processId - the BPEL process identifier

  Returns:

  the number of instances successfully deleted

  Throws:

  ServerException - either one of the following errors:

  • cannot connect to the domain,
  • no such process exists with the specified process identifier and revision tag,
  • problem deleting the instances from the domain.

  getOpenInstanceCount

  public int getOpenInstanceCount()
                           throws ServerException
  

  Returns the number of open instances that have been created in this process domain. An instance is considered open if it contains active activities.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getClosedInstanceCount

  public int getClosedInstanceCount()
                             throws ServerException
  

  Returns the number of closed instances that belong to this process domain. An instance is considered closed once it is completed.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  isArchivingEnabled

  public boolean isArchivingEnabled()
                             throws ServerException
  

  Returns true if at least one archive store has been defined for this process domain.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  archiveAllInstances

  public int archiveAllInstances(boolean deleteInstances)
                          throws ServerException
  

  Archives all closed instances in the process domain.

  Parameters:

  deleteInstances - set to true if each should be deleted after it has been successfully archived.

  Returns:

  the number of instances successfully archived

  Throws:

  ServerException - either one of the following errors:

  • problem connecting to the domain,
  • archiving has not been enabled for the domain,
  • problem archiving the instance,
  • problems deleting the instance from the datastore.

  archiveInstances

  public int archiveInstances(WhereCondition wc,
                              boolean deleteInstances)
                       throws ServerException
  

  Archives all instances returned by the search condition specified by wc.

  Parameters:

  wc - the where condition filter to apply to the search.

  deleteInstances - set to true if each should be deleted after it has been successfully archived.

  Returns:

  the number of instances successfully archived

  Throws:

  ServerException - either one of the following errors:

  • problem connecting to the domain,
  • an instance returned by the search condition is not in a closed state,
  • problem archiving the instance,
  • archiving has not been enabled for the domain,
  • problems deleting the instance from the datastore.

  archiveInstance

  public void archiveInstance(java.lang.String referenceId,
                              boolean deleteInstance)
                       throws ServerException
  

  Archives the specified instance.

  See AbstractIdentifier for the format of an Orabpel reference identifier.

  Parameters:

  referenceId - a reference identifier

  Returns:

  the number of instances successfully archived

  Throws:

  ServerException - either one of the following errors:

  • problem connecting to the domain,
  • the instance is not in a closed state,
  • problem archiving the instance,
  • archiving has not been enabled for the domain,
  • problems deleting the instance from the datastore.

  getSyncStatistics

  public Statistics[] getSyncStatistics()
                                 throws ServerException
  

  Returns a list of statistics regarding the process domain's performance with synchronous instances.

  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.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getAsyncStatistics

  public Statistics[] getAsyncStatistics()
                                  throws ServerException
  

  Returns a list of statistics regarding the process domain's performance with asynchronous instances.

  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.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getRequestStatistics

  public Statistics[] getRequestStatistics()
                                    throws ServerException
  

  Returns a list of statistics regarding the process domain's performance for individual requests.

  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.

  Throws:

  ServerException - if there is a problem connecting to the domain.

  clearStatistics

  public void clearStatistics()
                       throws ServerException
  

  Clears the current set of statistics gathered by the process domain (includes synchronous, asynchronous and request).

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getCacheTrace

  public java.lang.String getCacheTrace()
                                 throws ServerException
  

  Returns an XML dump of the current cache statistics for the BPEL domain. The XML content returned will contain the following for each cache used in the domain:

  • cache name,
  • cache policy (lru, soft, fifo),
  • the number of items currently contained in the cache,
  • the total size of the items contained in the cache (if available),
  • the high watermark level,
  • the low watermark level,
  • the unit of measurement used by the cache,
  • the number of insertions into the cache,
  • the number of hits recorded by the cache,
  • the number of misses recorded by the cache

  Throws:

  ServerException - if there is a problem connecting to the domain.

  getDispatcherTrace

  public java.lang.String getDispatcherTrace()
                                      throws ServerException
  

  Returns an XML dump of the current messages contained in the BPEL server's dispatcher. The XML content returned will contain:

  • Thread allocation information (current, high-water-mark, total),
  • A dump of the scheduled and working messages for each of the dispatch queues.

  Throws:

  ServerException - if there is a problem connecting to the domain or fetching the dispatcher trace.

  recoverActivities

  public int recoverActivities(java.lang.String[] correlationIds)
                        throws ServerException
  

  Schedules a list of activities to be recovered by the BPEL domain. The activities will not be recovered immediately but will be scheduled to be recovered asynchronously.

  Parameters:

  correlationIds - list of activity correlation identifiers.

  Returns:

  the number of activities successfully scheduled.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem scheduling the activities to be performed.

  recoverInvokeMessages

  public int recoverInvokeMessages(java.lang.String[] messageGUIDs)
                            throws ServerException
  

  Schedules a list of invocation messages to be recovered by the BPEL domain. The messages will not be resubmitted to the BPEL domain immediately but will be scheduled asynchronously.

  Parameters:

  messageGUIDs - list of invoke message GUIDs.

  Returns:

  the number of messages successfully scheduled.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem scheduling the messages to be resubmitted.

  cancelInvokeMessages

  public int cancelInvokeMessages(java.lang.String[] messageGUIDs)
                           throws ServerException
  

  Marks a list of invocation messages as cancelled by the BPEL domain.

  Parameters:

  messageGUIDs - list of invoke message GUIDs.

  Returns:

  the number of messages successfully cancelled.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem marking the messages as cancelled.

  deleteInvokeMessages

  public int deleteInvokeMessages(java.lang.String[] messageGUIDs)
                           throws ServerException
  

  Deletes a list of invocation messages from the BPEL domain.

  Parameters:

  messageGUIDs - list of invoke message GUIDs.

  Returns:

  the number of messages successfully deleted.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem deleting the messages from the datastore.

  recoverCallbackMessages

  public int recoverCallbackMessages(java.lang.String[] messageGUIDs)
                              throws ServerException
  

  Schedules a list of callback messages to be recovered by the BPEL domain. The messages will not be resubmitted to the BPEL domain immediately but will be scheduled asynchronously.

  Parameters:

  messageGUIDs - list of callback message GUIDs.

  Returns:

  the number of messages successfully scheduled.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem scheduling the messages to be resubmitted.

  cancelCallbackMessages

  public int cancelCallbackMessages(java.lang.String[] messageGUIDs)
                             throws ServerException
  

  Marks a list of callback messages as cancelled by the BPEL domain.

  Parameters:

  messageGUIDs - list of callback message GUIDs.

  Returns:

  the number of messages successfully cancelled.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem marking the messages as cancelled.

  deleteCallbackMessages

  public int deleteCallbackMessages(java.lang.String[] messageGUIDs)
                             throws ServerException
  

  Deletes a list of callback messages from the BPEL domain.

  Parameters:

  messageGUIDs - list of callback message GUIDs.

  Returns:

  the number of messages successfully deleted.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem deleting the messages from the datastore.

  getInvokeContent

  public java.lang.String getInvokeContent(java.lang.String messageGUID)
                                    throws ServerException
  

  Returns the invocation message with the specified message GUID.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem fetching the invocation message.

  getCallbackContent

  public java.lang.String getCallbackContent(java.lang.String messageGUID)
                                      throws ServerException
  

  Returns the callback message with the specified message GUID.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem fetching the callback message.

  clearWSDLCache

  public void clearWSDLCache()
                      throws ServerException
  

  Clear all the WSDLs cached in the WSDL manager of this domain. WSDLs are cached for performance reason.

  Throws:

  ServerException - if there is a problem connecting to the domain or if there is a problem clearing WSDLs cached in the domain.

  pingDispatcher

  public void pingDispatcher()
                      throws ServerException
  

  Pings the dispatcher by sending no-op message to the engine dispatcher.

  Throws:

  ServerException

  refreshAlarmTable

  public void refreshAlarmTable()
                         throws ServerException
  

  Throws:

  ServerException