|
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.AbstractIdentifier
com.oracle.bpel.client.CorrelationId
public final class CorrelationId
Implementation of an Orabpel correlation identifier. A correlation identifier is used to locate and identify an activity that has been started in an Orabpel process domain. Once an identifier has been constructed it is immutable.
Correlation identifiers may be constructed without specifying a process revision tag component. However, if such an identifier is passed to the process domain as an argument in a call which requires a process revision tag the revision most recently deployed (also known as the default revision) will be assumed. In most cases, the process revision tag can be determined with a database lookup using the instance id of the key; however it is best to specify the revision tag if it is known in advance.
Please refer to AbstractIdentifier
class for the URI format expected of correlation identifiers.
Field Summary | |
---|---|
static java.lang.String |
TYPE_ASSIGN Activity type for assign activity. |
static java.lang.String |
TYPE_EMPTY Activity type for empty activity. |
static java.lang.String |
TYPE_INVOKE Activity type for invoke activity. |
static java.lang.String |
TYPE_ONALARM Activity type for an onAlarm activity. |
static java.lang.String |
TYPE_ONMESSAGE Activity type for an onMessage activity. |
static java.lang.String |
TYPE_PICK Activity type for pick activity. |
static java.lang.String |
TYPE_RECEIVE Activity type for receive activity. |
static java.lang.String |
TYPE_RECEIVETASK Activity type for a task receive activity. |
static java.lang.String |
TYPE_REPLY Activity type for a reply activity. |
static java.lang.String |
TYPE_REQUESTTASK Activity type for a task receive activity. |
static java.lang.String |
TYPE_SCOPE Activity type for a scope activity. |
static java.lang.String |
TYPE_SEQUENCE Activity type for a sequence activity. |
static java.lang.String |
TYPE_SUBFLOW Activity type for a process activity. |
static java.lang.String |
TYPE_SWITCH Activity type for a switch activity. |
static java.lang.String |
TYPE_TERMINATE Activity type for a terminate activity. |
static java.lang.String |
TYPE_THROW Activity type for a throw activity. |
static java.lang.String |
TYPE_UNKNOWN Activity type for an unknown activity. |
static java.lang.String |
TYPE_WAIT Activity type for a wait activity. |
static java.lang.String |
TYPE_WHILE Activity type for a while activity. |
Fields inherited from class com.oracle.bpel.client.AbstractIdentifier |
---|
mBuf, mDomainId, mKey, mProcessId, mRevisionTag |
Constructor Summary | |
---|---|
CorrelationId(java.lang.String strFormat) Constructs a correlation identifier from the string representation of an identifier. |
|
CorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String activityKey) Constructs a correlation identifier with a domain identifier, process identifier and activity key. |
|
CorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String activityKey) Constructs a correlation identifier with a domain identifier, process identifier, revision tag and activity key. |
Method Summary | |
---|---|
java.lang.String |
getActivityType() Returns the activity type specified by this correlation identifier. |
static java.lang.String |
getActivityType(java.lang.String correlationId) Returns the activity type specified by the correlationId. |
static java.lang.String |
getCorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String activityKey) Convenience routine; avoids explicit creation of CorrelationId . |
static java.lang.String |
getCorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String activityKey) Convenience routine; avoids explicit creation of CorrelationId . |
Methods inherited from class com.oracle.bpel.client.AbstractIdentifier |
---|
getDomainId, getInstanceId, getKey, getProcessId, getRevisionTag, hasKey, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_ASSIGN
public static final java.lang.String TYPE_EMPTY
public static final java.lang.String TYPE_INVOKE
public static final java.lang.String TYPE_PICK
public static final java.lang.String TYPE_RECEIVE
public static final java.lang.String TYPE_REQUESTTASK
public static final java.lang.String TYPE_RECEIVETASK
public static final java.lang.String TYPE_REPLY
public static final java.lang.String TYPE_SCOPE
public static final java.lang.String TYPE_SUBFLOW
public static final java.lang.String TYPE_SEQUENCE
public static final java.lang.String TYPE_SWITCH
public static final java.lang.String TYPE_THROW
public static final java.lang.String TYPE_WAIT
public static final java.lang.String TYPE_ONALARM
public static final java.lang.String TYPE_ONMESSAGE
public static final java.lang.String TYPE_WHILE
public static final java.lang.String TYPE_TERMINATE
public static final java.lang.String TYPE_UNKNOWN
Constructor Detail |
---|
public CorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String activityKey)
domainId
- the Orabpel domain id; if null
is passed, the domain identifier will default to "unknown".processId
- the process identifier; if null
is passed, the process identifier will default to "*".revisionTag
- the process revision tag; this parameter is optional so null
can be passed in.activityKey
- the key used by the process domain to identify the activity.public CorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String activityKey)
domainId
- the Orabpel domain id; if null
is passed, the domain identifier will default to "unknown".processId
- the process identifier; if null
is passed, the process identifier will default to "*".activityKey
- the key used by the process domain to identify the activity.public CorrelationId(java.lang.String strFormat)
domain-id
process-id
revision-tag
key
strFormat
- the string representation of a correlation identifier.Method Detail |
---|
public static java.lang.String getCorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String activityKey)
CorrelationId
. Used to generate the string representation of a correlation identifier given its constituent parts.domainId
- the Orabpel domain id; if null
is passed, the domain identifier will default to "unknown".processId
- the process identifier; if null
is passed, the process identifier will default to "*".revisionTag
- the process revision tag; this parameter is optional so null
can be passed in.activityKey
- the key used by the process domain to identify the activity.public static java.lang.String getCorrelationId(java.lang.String domainId, java.lang.String processId, java.lang.String activityKey)
CorrelationId
. Performs the same action as getCorrelationId( String, String, String, String )
but allows for creation of a correlation identifier without a process revision tag.domainId
- the Orabpel domain id; if null
is passed, the domain identifier will default to "unknown".processId
- the process identifier; if null
is passed, the process identifier will default to "*".activityKey
- the key used by the process domain to identify the activity.public java.lang.String getActivityType()
public static java.lang.String getActivityType(java.lang.String correlationId)
correlationId
- the correlation identitifer string
|
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 |