com.oracle.bpel.client
Class AbstractIdentifier

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BPELProcessId, CorrelationId, ReferenceId

public abstract class AbstractIdentifier

extends java.lang.Object

implements java.io.Serializable

Abstract base class for Orabpel identifiers. This class provides a skeletal implementation of an identifier class, to minimize the effort required to implement sub-classes. An Orabpel identifier is used to locate and identify a process, instance or activity contained within a process domain.

The string representation of the identifier conforms to the URI format (RFC 2396) specified for identifying an abstract or physical resource on the network. The format is:

 bpel://<hostname>[:<portnumber>]/<domain-id>/<process-id>[~<revision-tag>][/<key>]
 

where:

hostname

is the machine name where the process domain has been installed.

portnumber

is an optional port number where the process domain can be reached.

domain-id

is the identifier of the process domain

process-id

is the identifier of the process

revision-tag

is an optional revision tag for the process; if none is specified, the most recent (also known as the default revision) will be assumed.

key

is the string representation of the instance or activity key

Since:

1.0

See Also:

Serialized Form

Constructor Summary

AbstractIdentifier(java.lang.String strFormat)
Constructs an identifier from the string representation of an identifier.

AbstractIdentifier(java.lang.String domainId, java.lang.String processId, java.lang.String key)
Constructs an identifier with a domain identifier, process identifier and key.

AbstractIdentifier(java.lang.String domainId, java.lang.String processId, java.lang.String revisionTag, java.lang.String key)
Constructs an identifier with a domain identifier, process identifier, revision tag and key.

Method Summary

java.lang.String	getDomainId() Returns the domain identifier.
java.lang.String	getInstanceId() Returns the instance id from the system key in String format.
java.lang.String	getKey() Returns the system key.
java.lang.String	getProcessId() Returns the process identifier.
java.lang.String	getRevisionTag() Returns the revision tag.
boolean	hasKey() Returns true if this identifier has been constructed with a system key component.
java.lang.String	toString() Returns a string representation of this identifier.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractIdentifier

public AbstractIdentifier(java.lang.String domainId,
                          java.lang.String processId,
                          java.lang.String revisionTag,
                          java.lang.String key)

Constructs an identifier with a domain identifier, process identifier, revision tag and 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.

key - the system key used by the process domain to identify the activity or instance.

AbstractIdentifier

public AbstractIdentifier(java.lang.String domainId,
                          java.lang.String processId,
                          java.lang.String key)

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

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 "*".

key - the system key used by the process domain to identify the activity or instance.

AbstractIdentifier

public AbstractIdentifier(java.lang.String strFormat)

Constructs an 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 an identifier

Method Detail

getDomainId

public final java.lang.String getDomainId()

Returns the domain identifier.

getProcessId

public final java.lang.String getProcessId()

Returns the process identifier.

getRevisionTag

public final java.lang.String getRevisionTag()

Returns the revision tag. This parameter is optional and will be null if this identifier has been constructed without a revision tag.

getKey

public final java.lang.String getKey()

Returns the system key. This key may be an instance or activity key.

getInstanceId

public java.lang.String getInstanceId()

Returns the instance id from the system key in String format. Both instance and activity keys contain an instance id. If the identifier does not contain a system key null is returned.

toString

public java.lang.String toString()

Returns a string representation of this identifier. The string representation will adhere to the following format:

 bpel://<hostname>[:<portnumber>]/<domain-id>/<process-id>[~<revision-tag>][/<key>]
 

where:

hostname

is the machine name where the process domain has been installed.

portnumber

is an optional port number where the process domain can be reached.

domain-id

is the identifier of the process domain

process-id

is the identifier of the process

revision-tag

is an optional revision tag for the process; if none is specified, the most recent (also known as the default revision) will be assumed.

key

is the string representation of the instance or activity key

hasKey

public final boolean hasKey()

Returns true if this identifier has been constructed with a system key component.