|
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 |
java.lang.Object
com.oracle.bpel.client.Locator
public final class Locator
The Locator
class allows the user to search for processes, instances and activities that have been deployed and instantiated within an Orabpel process domain.
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 |
---|
public Locator(java.lang.String domainId, java.util.Hashtable initContextProps) throws ServerException
initContextProperties
.
domainId
- the BPEL process domain identifierinitContextProperties
- the initial context properties to use to connect to a remote J2EE application server where the BPEL process domain is hostedServerException
- for either one of the following errors:
public Locator(java.lang.String domainId, java.lang.String password) throws ServerException
domainId
- the BPEL process domain identifierpassword
- the password for the domainServerException
- if cannot authenticate to the domain using the specified password, or if no such domain exists with the specified domain identifier.public Locator(java.lang.String domainId, java.lang.String password, java.lang.String ipAddress) throws ServerException
domainId
- the BPEL process domain identifierpassword
- the password for the domainipAddress
- IP address of the calling client (optional)ServerException
- if cannot authenticate to the domain using the specified password, or if no such domain exists with the specified domain identifier.public Locator(java.lang.String domainId, java.lang.String password, java.util.Hashtable pInitialContextProperties) throws ServerException
domainId
- the BPEL process domain identifierpassword
- the password for the domainpInitialContextProperties
- the RMI properties to connect to the the j2ee server hosting the BPEL process domainServerException
- 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.public Locator(java.lang.String domainId, java.lang.String password, java.lang.String ipAddress, java.util.Hashtable pInitialContextProperties) throws ServerException
pInitialContextProperties
.
domainId
- the BPEL process domain identifierpassword
- the password for the domainipAddress
- 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 hostedServerException
- either one of the following errors:
public Locator(DomainAuth auth)
auth
- authentication credentials for particular domainpublic Locator(DomainAuth auth, java.util.Hashtable pInitialContextProperties)
pInitialContextProperties
.
auth
- authentication credentials for particular domainpInitialContextProperties
- the initial context properties to use to connect to a remote J2EE application server where the BPEL process domain is hostedMethod Detail |
---|
public java.lang.String getDomainId()
public DomainAuth getDomainAuth()
public IBPELDomainHandle lookupDomain() throws ServerException
ServerException
- if there is a problem connecting to the domain.public IBPELProcessHandle lookupProcess(java.lang.String processId) throws ServerException
processId
. This method will return the default revision of the BPEL process (that is, the one most recently deployed to the process domain).processId
- the BPEL process identifier.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the handle of the requested process.public IBPELProcessHandle lookupProcess(java.lang.String processId, java.lang.String revisionTag) throws ServerException
processId
and revision tag revisionTag
.processId
- the BPEL process identifier.revisionTag
- the BPEL Process revision tag.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the handle of the requested process.public 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.public IBPELProcessHandle[] listAllRevisions(java.lang.String processId) throws ServerException
This method will throw a ServerException
if the process has not loaded successfully.
ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of processes.public BPELProcessEvent[] listProcessEvents(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 events to return starting from the starting index.listStart
- the starting point within the result set.listSize
- the total number of items to return. No limit if -1
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of events from the domain.public BPELProcessEvent[] listProcessEvents(WhereCondition wc) throws ServerException
wc
.wc
- the where condition filter to apply to the search.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of events from the domain.public BPELProcessEvent[] listProcessEvents(WhereCondition wc, int listStart, int listSize) throws ServerException
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.
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
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of events from the domain.public IInstanceHandle lookupInstance(java.lang.String key) throws ServerException
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.
key
- the instance key.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the instance from the domain.public IInstanceHandle lookupInstanceByConversationId(java.lang.String convId) throws ServerException
convId
.convId
- the conversation id.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the instance from the domain.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. No limit if -1
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of instances from the domain.public IInstanceHandle[] listInstances(WhereCondition wc) throws ServerException
wc
.wc
- the where condition filter to apply to the search.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of instances from the domain.public IInstanceHandle[] listInstances(WhereCondition wc, int listStart, int listSize) throws ServerException
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.
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
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of instances from the domain.public IInstanceHandle[] listInstancesByIndex(WhereCondition wc) throws ServerException
ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of instances from the domain.public IInstanceHandle[] listInstancesByIndex(WhereCondition wc, int listStart, int listSize) throws ServerException
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.
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
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of instances from the domain.public IActivityHandle lookupActivity(java.lang.String correlationId) throws ServerException
correlationId
.
See CorrelationId
for the format of an activity correlation identifier.
correlationId
- an activity's correlation identifier.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the activity from the domain.public IActivityHandle[] listActivities(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. No limit if -1
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of activities from the domain.public IActivityHandle[] listActivities(WhereCondition wc) throws ServerException
wc
.wc
- the where condition filter to apply to the search.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of activities from the domain.public IActivityHandle[] listActivities(WhereCondition wc, int listStart, int listSize) throws ServerException
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.
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
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of activities from the domain.public com.oracle.bpel.client.IInvokeMetaData[] listInvokeMessages(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. No limit if -1
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of messages from the domain.public com.oracle.bpel.client.IInvokeMetaData[] listInvokeMessages(WhereCondition wc) throws ServerException
wc
.wc
- the where condition filter to apply to the search.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of messages from the domain.public com.oracle.bpel.client.IInvokeMetaData[] listInvokeMessages(WhereCondition wc, int listStart, int listSize) throws ServerException
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.
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
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of messages from the domain.public ICallbackMetaData[] listCallbackMessages(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. No limit if -1
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of messages from the domain.public ICallbackMetaData[] listCallbackMessages(WhereCondition wc) throws ServerException
wc
.wc
- the where condition filter to apply to the search.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of messages from the domain.public ICallbackMetaData[] listCallbackMessages(WhereCondition wc, int listStart, int listSize) throws ServerException
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.
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
.ServerException
- if there is a problem connecting to the domain or if there is a problem fetching the list of messages from the domain.public IService lookupService(java.lang.String serviceName)
serviceName
. Currently recognized service names are:
IWorkListService#SERVICE_NAME
IDeliveryService#SERVICE_NAME
IDeliveryService#LOCAL_SERVICE_NAME
serviceName
- the name of the serviceIService
instance
|
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 |