Skip navigation links

com.oracle.bpel.client
Class ReferenceId

java.lang.Object
com.oracle.bpel.client.AbstractIdentifier
com.oracle.bpel.client.ReferenceId

All Implemented Interfaces:

java.io.Serializable

public final class ReferenceId

extends AbstractIdentifier

implements java.io.Serializable

Implementation of an Orabpel reference identifier. A reference identifier is used to locate and identify an instance that has been started in an Orabpel process domain. Once an identifier has been constructed it is immutable.

Reference 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 reference identifiers.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.oracle.bpel.client.AbstractIdentifier

mBuf, mDomainId, mKey, mProcessId, mRevisionTag

Constructor Summary

ReferenceId(java.lang.String strFormat)
Constructs a reference identifier from the string representation of an identifier.

ReferenceId(java.lang.String domainId, java.lang.String instanceKey)
Constructs a reference identifier with a domain identifier and instance key.

ReferenceId(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String instanceKey)
Constructs a reference identifier with a domain identifier, process identifier, revision tag and instance key.

Method Summary

static java.lang.String	getReferenceId(java.lang.String domainId, java.lang.String instanceKey) Convenience routine; avoids explicit creation of ReferenceId.
static java.lang.String	getReferenceId(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String instanceKey) Convenience routine; avoids explicit creation of ReferenceId.

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

Constructor Detail

ReferenceId

public ReferenceId(java.lang.String domainId,
                   java.lang.String processId,
                   java.lang.String revisionTag,
                   java.lang.String instanceKey)

Constructs a reference identifier with a domain identifier, process identifier, revision tag and instance key.

Parameters:

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.

instanceKey - the key used by the process domain to identify the instance.

ReferenceId

public ReferenceId(java.lang.String domainId,
                   java.lang.String instanceKey)

Constructs a reference identifier with a domain identifier and instance key. This constructor is provided for convenience purposes when the process identifier or process revision tag is not known.

In an Orabpel process domain, the instance key is sufficient to uniquely identify an instance.

Parameters:

domainId - the Orabpel domain id; if null is passed, the domain identifier will default to "unknown".

instanceKey - the key used by the process domain to identify the instance.

ReferenceId

public ReferenceId(java.lang.String strFormat)

Constructs a reference identifier from the string representation of an identifier. The string is expected to conform to the URI format of an identifier, otherwise the default values for each of the identifier parts will be assumed.

domain-id

"default"

process-id

"*"

revision-tag

null

key

null

Parameters:

strFormat - the string representation of a reference identifier

Method Detail

getReferenceId

public static java.lang.String getReferenceId(java.lang.String domainId,
                                              java.lang.String processId,
                                              java.lang.String revisionTag,
                                              java.lang.String instanceKey)

Convenience routine; avoids explicit creation of ReferenceId. Used to generate the string representation of a reference identifier given its constituent parts.

Parameters:

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.

instanceKey - the key used by the process domain to identify the instance.

getReferenceId

public static java.lang.String getReferenceId(java.lang.String domainId,
                                              java.lang.String instanceKey)

Convenience routine; avoids explicit creation of ReferenceId. Performs the same action as getReferenceId( String, String, String, String ) but allows for creation of a reference identifier without a process identifier or process revision tag.

In an Orabpel process domain, the instance key is sufficient to uniquely identify an instance.

Parameters:

domainId - the Orabpel domain id; if null is passed, the domain identifier will default to "unknown".

instanceKey - the key used by the process domain to identify the instance.

Skip navigation links