Skip navigation links

com.oracle.bpel.client
Class Locator

java.lang.Object
com.oracle.bpel.client.Locator

All Implemented Interfaces:

java.io.Serializable

public final class Locator

extends java.lang.Object

implements java.io.Serializable

The Locator class allows the user to search for processes, instances and activities that have been deployed and instantiated within an Orabpel process domain.

Since:

1.0

See Also:

Serialized Form

Constructor Summary

Locator(DomainAuth auth)
Constructs a service locator with an existing set of domain authentication credentials.

Locator(DomainAuth auth, java.util.Hashtable pInitialContextProperties)
Constructs a service locator with an existing set of domain authentication credentials.

Locator(java.lang.String domainId, java.util.Hashtable initContextProps)
Constructs a service locator that points to the specified BPEL process domain located on the J2EE server specified by the context properties in initContextProperties.

Locator(java.lang.String domainId, java.lang.String password)
Constructs a service locator that points to the specified BPEL process domain.

Locator(java.lang.String domainId, java.lang.String password, java.util.Hashtable pInitialContextProperties)
Constructs a service locator that points to the specified BPEL process domain.

Locator(java.lang.String domainId, java.lang.String password, java.lang.String ipAddress)
Constructs a service locator that points to the specified BPEL process domain.

Locator(java.lang.String domainId, java.lang.String password, java.lang.String ipAddress, java.util.Hashtable pInitialContextProperties)
Constructs a service locator that points to the specified BPEL process domain located on the J2EE server specified by the context properties in pInitialContextProperties.

Method Summary

DomainAuth	getDomainAuth() Returns the domain authentication credentials used to gain access to the BPEL process domain specified by this service locator.
java.lang.String	getDomainId() Returns the domain identifier for the BPEL process domain specified by this service locator.
IActivityHandle[]	listActivities(int listStart, int listSize) Returns a list of all the open activities in the process domain.
IActivityHandle[]	listActivities(WhereCondition wc) Returns a list of activities using the search condition specified by wc.
IActivityHandle[]	listActivities(WhereCondition wc, int listStart, int listSize) Performs the same action as listActivities( WhereCondition ) but allows the user to specify how much of the result set to return.
IBPELProcessHandle[]	listAllRevisions(java.lang.String processId) Returns the list of revisions deployed for this BPEL process.
ICallbackMetaData[]	listCallbackMessages(int listStart, int listSize) Returns a list of all the callback message received by the process domain.
ICallbackMetaData[]	listCallbackMessages(WhereCondition wc) Returns a list of callback messages received by the process domain using the search condition specified by wc.
ICallbackMetaData[]	listCallbackMessages(WhereCondition wc, int listStart, int listSize) Performs the same action as listCallbackMessages( WhereCondition ) but allows the user to specify how much of the result set to return.
IInstanceHandle[]	listInstances(int listStart, int listSize) Returns a list of all the active instances in the process domain.
IInstanceHandle[]	listInstances(WhereCondition wc) Returns a list of instances using the search condition specified by wc.
IInstanceHandle[]	listInstances(WhereCondition wc, int listStart, int listSize) Performs the same action as listInstances( WhereCondition ) but allows the user to specify how much of the result set to return.
IInstanceHandle[]	listInstancesByIndex(WhereCondition wc) Returns a list of instances in the process domain which have the specified indexes set.
IInstanceHandle[]	listInstancesByIndex(WhereCondition wc, int listStart, int listSize) Performs the same action as listInstancesByIndex( WhereCondition ) but allows the user to specify how much of the result set to return.
com.oracle.bpel.client.IInvokeMetaData[]	listInvokeMessages(int listStart, int listSize) Returns a list of all the invocation message received by the process domain.
com.oracle.bpel.client.IInvokeMetaData[]	listInvokeMessages(WhereCondition wc) Returns a list of invocation messages received by the process domain using the search condition specified by wc.
com.oracle.bpel.client.IInvokeMetaData[]	listInvokeMessages(WhereCondition wc, int listStart, int listSize) Performs the same action as listInvokeMessages( WhereCondition ) but allows the user to specify how much of the result set to return.
IBPELProcessHandle[]	listProcesses() Returns a list of handles to the BPEL processes that have been successfully deployed to the process domain.
BPELProcessEvent[]	listProcessEvents(int listStart, int listSize) Returns a list of events that have been logged for processes deployed by the domain.
BPELProcessEvent[]	listProcessEvents(WhereCondition wc) Returns a list of events that have been logged for processes deployed by the domain.
BPELProcessEvent[]	listProcessEvents(WhereCondition wc, int listStart, int listSize) Performs the same action as listProcessEvents( WhereCondition ) but allows the user to specify how much of the result set to return.
IActivityHandle	lookupActivity(java.lang.String correlationId) Returns a handle to the activity specified by the correlation identifier correlationId.
IBPELDomainHandle	lookupDomain() Returns a handle to the BPEL process domain specified by this service locator.
IInstanceHandle	lookupInstance(java.lang.String key) Returns a handle to the instance specified by key.
IInstanceHandle	lookupInstanceByConversationId(java.lang.String convId) Returns a handle to the instance specified by convId.
IBPELProcessHandle	lookupProcess(java.lang.String processId) Returns a handle to the BPEL process with identifier processId.
IBPELProcessHandle	lookupProcess(java.lang.String processId, java.lang.String revisionTag) Returns a handle to the BPEL process with identifier processId and revision tag revisionTag.
IService	lookupService(java.lang.String serviceName) Returns the service object with identifier serviceName.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Locator

public Locator(java.lang.String domainId,
               java.util.Hashtable initContextProps)
        throws ServerException

Constructs a service locator that points to the specified BPEL process domain located on the J2EE server specified by the context properties in initContextProperties.

Parameters:

domainId - the BPEL process domain identifier

initContextProperties - the initial context properties to use to connect to a remote J2EE application server where the BPEL process domain is hosted

Throws:

ServerException - for either one of the following errors:

• no such domain exists with the specified domain identifier,
• unable to connect to the remote J2EE application server with the specified context properties.

Locator

public Locator(java.lang.String domainId,
               java.lang.String password)
        throws ServerException

Constructs a service locator that points to the specified BPEL process domain.

Parameters:

domainId - the BPEL process domain identifier

password - the password for the domain

Throws:

ServerException - if cannot authenticate to the domain using the specified password, or if no such domain exists with the specified domain identifier.

Locator

public Locator(java.lang.String domainId,
               java.lang.String password,
               java.lang.String ipAddress)
        throws ServerException

Constructs a service locator that points to the specified BPEL process domain.

Parameters:

domainId - the BPEL process domain identifier

password - the password for the domain

ipAddress - IP address of the calling client (optional)

Throws:

ServerException - if cannot authenticate to the domain using the specified password, or if no such domain exists with the specified domain identifier.

Locator

public Locator(java.lang.String domainId,
               java.lang.String password,
               java.util.Hashtable pInitialContextProperties)
        throws ServerException

Constructs a service locator that points to the specified BPEL process domain. This method should be used if the BPEL server is hosted on a remote server. The connection to the remote server will be made using the provided RMI connection properties.

Parameters:

domainId - the BPEL process domain identifier

password - the password for the domain

pInitialContextProperties - the RMI properties to connect to the the j2ee server hosting the BPEL process domain

Throws:

ServerException - if cannot authenticate to the domain using the specified password, if no such domain exists with the specified domain identifier or if there are problems connecting to the remote server with the specified RMI properties.

Locator

public Locator(java.lang.String domainId,
               java.lang.String password,
               java.lang.String ipAddress,
               java.util.Hashtable pInitialContextProperties)
        throws ServerException

Constructs a service locator that points to the specified BPEL process domain located on the J2EE server specified by the context properties in pInitialContextProperties.

Parameters:

domainId - the BPEL process domain identifier

password - the password for the domain

ipAddress - IP address of the calling client (optional)

pInitialContextProperties - the initial context properties to use to connect to a remote J2EE application server where the BPEL process domain is hosted

Throws:

ServerException - either one of the following errors:

• cannot authenticate to the domain using the specified password,
• no such domain exists with the specified domain identifier,
• unable to connect to the remote J2EE application server with the specified context properties.

Locator

public Locator(DomainAuth auth)

Constructs a service locator with an existing set of domain authentication credentials.

Parameters:

auth - authentication credentials for particular domain

Locator

public Locator(DomainAuth auth,
               java.util.Hashtable pInitialContextProperties)

Constructs a service locator with an existing set of domain authentication credentials. A connection to the BPEL process domain will be established using the context properties in pInitialContextProperties.

Parameters:

auth - authentication credentials for particular domain

pInitialContextProperties - the initial context properties to use to connect to a remote J2EE application server where the BPEL process domain is hosted

Method Detail

getDomainId

public java.lang.String getDomainId()

Returns the domain identifier for the BPEL process domain specified by this service locator.

getDomainAuth

public DomainAuth getDomainAuth()

Returns the domain authentication credentials used to gain access to the BPEL process domain specified by this service locator.

lookupDomain

public IBPELDomainHandle lookupDomain()
                               throws ServerException

Returns a handle to the BPEL process domain specified by this service locator.

Throws:

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

lookupProcess

public IBPELProcessHandle lookupProcess(java.lang.String processId)
                                 throws ServerException

Returns a handle to the BPEL process with identifier processId. This method will return the default revision of the BPEL process (that is, the one most recently deployed to the process domain).

Parameters:

processId - the BPEL process identifier.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the handle of the requested process.

lookupProcess

public IBPELProcessHandle lookupProcess(java.lang.String processId,
                                        java.lang.String revisionTag)
                                 throws ServerException

Returns a handle to the BPEL process with identifier processId and revision tag revisionTag.

Parameters:

processId - the BPEL process identifier.

revisionTag - the BPEL Process revision tag.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the handle of the requested process.

listProcesses

public IBPELProcessHandle[] listProcesses()
                                   throws ServerException

Returns a list of handles to the BPEL processes that have been successfully deployed to the process domain. This list will contain both open (processes that can instantiate new instances) and closed (processes that cannot instantiate new instances) processes.

Throws:

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

listAllRevisions

public IBPELProcessHandle[] listAllRevisions(java.lang.String processId)
                                      throws ServerException

Returns the list of revisions deployed for this BPEL process. All revisions have the same process identifier but different revision tags. The returned list is sorted in order of deployment time: most recent to last.

This method will throw a ServerException if the process has not loaded successfully.

Throws:

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

listProcessEvents

public BPELProcessEvent[] listProcessEvents(int listStart,
                                            int listSize)
                                     throws ServerException

Returns a list of events that have been logged for processes deployed by the domain. Events are logged whenever processes are deployed, undeployed, mark as the default revision or whenever an error is encountered. This method allows the user to specify how many events to return from the result set; listStart specifies the starting point within the result set from the beginning (0 being the first index), and listSize being the number of events to return starting from the starting index.

Parameters:

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listProcessEvents

public BPELProcessEvent[] listProcessEvents(WhereCondition wc)
                                     throws ServerException

Returns a list of events that have been logged for processes deployed by the domain. This method uses the search condition specified by wc.

Parameters:

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

Throws:

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

listProcessEvents

public BPELProcessEvent[] listProcessEvents(WhereCondition wc,
                                            int listStart,
                                            int listSize)
                                     throws ServerException

Performs the same action as listProcessEvents( WhereCondition ) but allows the user to specify how much of the result set to return. This method is handy if only a small subset of the entire search space is required.

listStart specifies the starting point within the result set from the beginning (0 being the first index), and listSize being the number of events to return starting from the starting index.

Parameters:

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

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

lookupInstance

public IInstanceHandle lookupInstance(java.lang.String key)
                               throws ServerException

Returns a handle to the instance specified by key. This key can either be a complete URI (starting with the scheme bpel or a user-defined uuid (also called a custom key).

See AbstractIdentifier for the format of an Orabpel instance URI.

When an instance is created the user may pass the process domain a user-specified "custom" key; this key has no system-specific meaning and is only available as a means for linking an Orabpel process instance with an external system.

Parameters:

key - the instance key.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the instance from the domain.

lookupInstanceByConversationId

public IInstanceHandle lookupInstanceByConversationId(java.lang.String convId)
                                               throws ServerException

Returns a handle to the instance specified by convId.

Parameters:

convId - the conversation id.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the instance from the domain.

listInstances

public IInstanceHandle[] listInstances(int listStart,
                                       int listSize)
                                throws ServerException

Returns a list of all the active instances in the process domain. This method allows the user to specify how many instances to return from the result set; 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.

Parameters:

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listInstances

public IInstanceHandle[] listInstances(WhereCondition wc)
                                throws ServerException

Returns a list of instances using the search condition specified by wc.

Parameters:

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

Throws:

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

listInstances

public IInstanceHandle[] listInstances(WhereCondition wc,
                                       int listStart,
                                       int listSize)
                                throws ServerException

Performs the same action as listInstances( WhereCondition ) but allows the user to specify how much of the result set to return. This method is handy if only a small subset of the entire search space is required; the process domain will not bother to load the instances that are not returned.

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.

Parameters:

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

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listInstancesByIndex

public IInstanceHandle[] listInstancesByIndex(WhereCondition wc)
                                       throws ServerException

Returns a list of instances in the process domain which have the specified indexes set.

Throws:

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

listInstancesByIndex

public IInstanceHandle[] listInstancesByIndex(WhereCondition wc,
                                              int listStart,
                                              int listSize)
                                       throws ServerException

Performs the same action as listInstancesByIndex( WhereCondition ) but allows the user to specify how much of the result set to return. This method is handy if only a small subset of the entire search space is required; the process domain will not bother to load the instances that are not returned.

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.

Parameters:

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

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

lookupActivity

public IActivityHandle lookupActivity(java.lang.String correlationId)
                               throws ServerException

Returns a handle to the activity specified by the correlation identifier correlationId.

See CorrelationId for the format of an activity correlation identifier.

Parameters:

correlationId - an activity's correlation identifier.

Throws:

ServerException - if there is a problem connecting to the domain or if there is a problem fetching the activity from the domain.

listActivities

public IActivityHandle[] listActivities(int listStart,
                                        int listSize)
                                 throws ServerException

Returns a list of all the open activities in the process domain. This method allows the user to specify how many activities to return from the result set; 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.

Parameters:

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listActivities

public IActivityHandle[] listActivities(WhereCondition wc)
                                 throws ServerException

Returns a list of activities using the search condition specified by wc.

Parameters:

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

Throws:

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

listActivities

public IActivityHandle[] listActivities(WhereCondition wc,
                                        int listStart,
                                        int listSize)
                                 throws ServerException

Performs the same action as listActivities( WhereCondition ) but allows the user to specify how much of the result set to return. This method is handy if only a small subset of the entire search space is required; the process domain will not bother to load the activities that are not returned.

listStart specifies the starting point within the result set from the beginning (0 being the first index), and listSize being the number of activities to return starting from the starting index.

Parameters:

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

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listInvokeMessages

public com.oracle.bpel.client.IInvokeMetaData[] listInvokeMessages(int listStart,
                                                                   int listSize)
                                                            throws ServerException

Returns a list of all the invocation message received by the process domain. This method allows the user to specify how many messages to return from the result set; 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.

Parameters:

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listInvokeMessages

public com.oracle.bpel.client.IInvokeMetaData[] listInvokeMessages(WhereCondition wc)
                                                            throws ServerException

Returns a list of invocation messages received by the process domain using the search condition specified by wc.

Parameters:

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

Throws:

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

listInvokeMessages

public com.oracle.bpel.client.IInvokeMetaData[] listInvokeMessages(WhereCondition wc,
                                                                   int listStart,
                                                                   int listSize)
                                                            throws ServerException

Performs the same action as listInvokeMessages( WhereCondition ) but allows the user to specify how much of the result set to return. This method is handy if only a small subset of the entire search space is required; the process domain will not bother to load the invocation messages that are not returned.

listStart specifies the starting point within the result set from the beginning (0 being the first index), and listSize being the number of messages to return starting from the starting index.

Parameters:

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

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listCallbackMessages

public ICallbackMetaData[] listCallbackMessages(int listStart,
                                                int listSize)
                                         throws ServerException

Returns a list of all the callback message received by the process domain. This method allows the user to specify how many messages to return from the result set; 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.

Parameters:

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

listCallbackMessages

public ICallbackMetaData[] listCallbackMessages(WhereCondition wc)
                                         throws ServerException

Returns a list of callback messages received by the process domain using the search condition specified by wc.

Parameters:

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

Throws:

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

listCallbackMessages

public ICallbackMetaData[] listCallbackMessages(WhereCondition wc,
                                                int listStart,
                                                int listSize)
                                         throws ServerException

Performs the same action as listCallbackMessages( WhereCondition ) but allows the user to specify how much of the result set to return. This method is handy if only a small subset of the entire search space is required; the process domain will not bother to load the invocation messages that are not returned.

listStart specifies the starting point within the result set from the beginning (0 being the first index), and listSize being the number of messages to return starting from the starting index.

Parameters:

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

listStart - the starting point within the result set.

listSize - the total number of items to return. No limit if -1.

Throws:

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

lookupService

public IService lookupService(java.lang.String serviceName)

Returns the service object with identifier serviceName. Currently recognized service names are:

IWorkListService#SERVICE_NAME

used to search for and complete user tasks.

IDeliveryService#SERVICE_NAME

used to instantiate new instances in the domain.

IDeliveryService#LOCAL_SERVICE_NAME

used to instantiate new instances locally from within the engine.

Parameters:

serviceName - the name of the service

Returns:

the service as an IService instance

Skip navigation links