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

java.lang.Object
  |
  +--com.ibm.etools.logging.pd.artifacts.PD_LogRecord_Correlator

public class PD_LogRecord_Correlator
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 correlator is actually composed of two PD_TransportCorrelators, the parent and the child correlators. First one is the PD_TransportCorrelator that was imported into the current machine (i.e., the remote PD_TransportCorrelator) and the second one is the PD_TransportCorrelator that was generated locally on the current machine (i.e., the local in relation to the first PD_TransportCorrelator). The PD_LogRecord_Correlator is not transported over the wire. This correlator is returned to the instrumentation and logging mechanism. The PD_LogRecord_Correlator and the current application/middleware log data will be logged into a file (e.g. Event.log) as part of the Application artifact for deterministic correlation purpose. 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
PD_LogRecord_Correlator(PD_TransportCorrelator pd_LogRecord_Correlator_currentTransportCorrelator)
           
 
Method Summary
 PD_TransportCorrelator getCurrentTransportCorrelator()
          Gets the value of the currentTransportCorrelator instance variable.
 PD_TransportCorrelator getRemoteTransportCorrelator()
          Gets the value of the remoteTransportCorrelator instance variable.
 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.
 void setCurrentTransportCorrelator(PD_TransportCorrelator pd_LogRecord_Correlator_currentTransportCorrelator)
          Sets value of the currentTransportCorrelator instance variable to the specified value.
 void setRemoteTransportCorrelator(PD_TransportCorrelator pd_LogRecord_Correlator_remoteTransportCorrelator)
          Sets value of the remoteTransportCorrelator instance variable to the specified value.
 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

PD_LogRecord_Correlator

public PD_LogRecord_Correlator(PD_TransportCorrelator pd_LogRecord_Correlator_currentTransportCorrelator)
Method Detail

getUniqueInstanceID

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

Returns:
The value of the uniqueInstanceID instance variable.

setRemoteTransportCorrelator

public void setRemoteTransportCorrelator(PD_TransportCorrelator pd_LogRecord_Correlator_remoteTransportCorrelator)
Sets value of the remoteTransportCorrelator instance variable to the specified value.

Parameters:
pd_LogRecord_Correlator_remoteTransportCorrelator - The new value of the remoteTransportCorrelator instance variable.

getRemoteTransportCorrelator

public PD_TransportCorrelator getRemoteTransportCorrelator()
Gets the value of the remoteTransportCorrelator instance variable.

Returns:
The value of the remoteTransportCorrelator instance variable, or null if the value of the remoteTransportCorrelator instance variable has not been set or is set to null.

setCurrentTransportCorrelator

public void setCurrentTransportCorrelator(PD_TransportCorrelator pd_LogRecord_Correlator_currentTransportCorrelator)
Sets value of the currentTransportCorrelator instance variable to the specified value.

Parameters:
pd_LogRecord_Correlator_currentTransportCorrelator - The new value of the currentTransportCorrelator instance variable.

getCurrentTransportCorrelator

public PD_TransportCorrelator getCurrentTransportCorrelator()
Gets the value of the currentTransportCorrelator instance variable.

Returns:
The value of the currentTransportCorrelator instance variable, or null if the value of the currentTransportCorrelator instance variable has not been set or is set to null.

toCanonicalXMLString

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

Returns:
the canonical XML representation of this object

regenerateUniqueInstanceID

public void regenerateUniqueInstanceID()
Regenerates a new unique instance ID for the 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.