com.ibm.etools.logging.pd.artifacts
Class GloballyUniqueCorrelator

java.lang.Object
  |
  +--com.ibm.etools.logging.pd.artifacts.GloballyUniqueCorrelator
Direct Known Subclasses:
GenericGloballyUniqueCorrelator, PD_GloballyUniqueCorrelator

public abstract class GloballyUniqueCorrelator
extends java.lang.Object

Licensed Material - Property of IBM (C) Copyright IBM Corp. 2003, 2005 All Rights Reserved. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. This is an abstract class that defines the Globally Unique Correlator. Unique Identifier for the correlator instance (e.g., Globally Unique Correlator (GUC)). This is the identifier that will be use by the correlation engine to associate the PD_LocalInstanceCorrelator data to the PD_TransportCorrelator. This is a mandatory property. When reusing the object, users may re-initialize the object to a newly constructed state via the init() API. Otherwise, to reuse a partially initialized object, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.


Constructor Summary
GloballyUniqueCorrelator()
          GloballyUniqueCorrelator constructors
 
Method Summary
 java.lang.String getUniqueInstanceID()
          Gets the value of the uniqueInstanceID instance variable.
 void init()
          Initializes the object to a newly constructed state.
 void regenerateUniqueInstanceID()
          Regenerates a new unique instance ID for the object.
 java.lang.String toCanonicalXMLString()
          Creates the canonical XML representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GloballyUniqueCorrelator

public GloballyUniqueCorrelator()
GloballyUniqueCorrelator constructors

Method Detail

getUniqueInstanceID

public java.lang.String getUniqueInstanceID()
Gets the value of the uniqueInstanceID instance variable.

Returns:
The value of the uniqueInstanceID instance variable.

regenerateUniqueInstanceID

public void regenerateUniqueInstanceID()
Regenerates a new unique instance ID for the object.


toCanonicalXMLString

public java.lang.String toCanonicalXMLString()
Creates the canonical XML representation of this object.

Returns:
the canonical XML representation of this object

init

public void init()
Initializes the object to a newly constructed state. NOTE: To reuse the object without calling the init() API, the uniqueInstanceID instance variable MUST be regenerated via the regenerateUniqueInstanceID() API.