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

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

public class PD_TransportCorrelator
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 the information that is flown over the wire. It consists of minimum amount of data required to uniquely identify a unit of work to minimize any performance impact or system operation. It consists of a of a correlator length, format and flags, a header extension flag, a Globally Unique Correlator length, a Globally Unique Correlator (GUC) and optionally, an additional correlator length and the additional correlator data to hold any product specific correlator data. For the e2e Problem Determination purpose, the GUC will consists of a GUID and two sequence counters. 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_TransportCorrelator(GloballyUniqueCorrelator pd_TransportCorrelator_globallyUniqueCorrelatorValue)
           
 
Method Summary
 PD_Additional_Correlator_Info[] getAdditionalCorrelatorInfoList()
          Gets the value of the additionalCorrelatorInfoList instance variable.
 byte[] getAdditionalCorrelatorSize()
          Gets the value of the additionalCorrelatorSize instance variable.
 byte getCorrelator_Format()
          Gets the value of the correlator_Format instance variable.
 byte getFlags()
          Gets the value of the flags instance variable.
 GloballyUniqueCorrelator getGloballyUniqueCorrelatorValue()
          Gets the value of the globallyUniqueCorrelatorValue instance variable.
 byte[] getGUC_Length()
          Gets the value of the guc_Length instance variable.
 byte getIsExtended()
          Gets the value of the isExtended instance variable.
 byte[] getLength()
          Gets the value of the length instance variable.
 long getProcessCallingSequenceCounter()
          Gets the value of the processCallingSequenceCounter instance variable.
 byte getReserved()
          Gets the value of the reserved instance variable.
 short getThreadCallingSequenceCounter()
          Gets the value of the threadCallingSequenceCounter instance variable.
 byte getType()
          Gets the value of the type instance variable.
 java.lang.String getUniqueInstanceID()
          Gets the value of the uniqueInstanceID instance variable.
 byte getVersion()
          Gets the value of the version instance variable.
 void init()
          Initializes the object to a newly constructed state.
 void regenerateUniqueInstanceID()
          Regenerates a new unique instance ID for the object.
 void setAdditionalCorrelatorInfoList(PD_Additional_Correlator_Info[] pd_TransportCorrelator_additionalCorrelatorInfoList)
          Sets value of the additionalCorrelatorInfoList instance variable to the specified value.
 void setAdditionalCorrelatorSize(byte[] pd_TransportCorrelator_additionalCorrelatorSize)
          Sets value of the additionalCorrelatorSize instance variable to the specified value.
 void setCorrelator_Format(byte pd_TransportCorrelator_correlator_Format)
          Sets value of the correlator_Format instance variable to the specified value.
 void setFlags(byte pd_TransportCorrelator_flags)
          Sets value of the flags instance variable to the specified value.
 void setGloballyUniqueCorrelatorValue(GloballyUniqueCorrelator pd_TransportCorrelator_globallyUniqueCorrelatorValue)
          Sets value of the globallyUniqueCorrelatorValue instance variable to the specified value.
 void setGUC_Length(byte[] pd_TransportCorrelator_guc_Length)
          Sets value of the guc_Length instance variable to the specified value.
 void setIsExtended(byte pd_TransportCorrelator_isExtended)
          Sets value of the isExtended instance variable to the specified value.
 void setLength(byte[] pd_TransportCorrelator_length)
          Sets value of the length instance variable to the specified value.
 void setProcessCallingSequenceCounter(long pd_TransportCorrelator_processCallingSequenceCounter)
          Sets value of the processCallingSequenceCounter instance variable to the specified value.
 void setReserved(byte pd_TransportCorrelator_reserved)
          Sets value of the reserved instance variable to the specified value.
 void setThreadCallingSequenceCounter(short pd_TransportCorrelator_threadCallingSequenceCounter)
          Sets value of the threadCallingSequenceCounter instance variable to the specified value.
 void setType(byte pd_TransportCorrelator_type)
          Sets value of the type instance variable to the specified value.
 void setVersion(byte pd_TransportCorrelator_version)
          Sets value of the version 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_TransportCorrelator

public PD_TransportCorrelator(GloballyUniqueCorrelator pd_TransportCorrelator_globallyUniqueCorrelatorValue)
Method Detail

getUniqueInstanceID

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

Returns:
The value of the uniqueInstanceID instance variable.

setReserved

public void setReserved(byte pd_TransportCorrelator_reserved)
Sets value of the reserved instance variable to the specified value.

Parameters:
pd_TransportCorrelator_reserved - The new value of the reserved instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter byte is not between 0 and 1.

getReserved

public byte getReserved()
Gets the value of the reserved instance variable.

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

setType

public void setType(byte pd_TransportCorrelator_type)
Sets value of the type instance variable to the specified value.

Parameters:
pd_TransportCorrelator_type - The new value of the type instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter byte is not between 0 and 15.

getType

public byte getType()
Gets the value of the type instance variable.

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

setVersion

public void setVersion(byte pd_TransportCorrelator_version)
Sets value of the version instance variable to the specified value.

Parameters:
pd_TransportCorrelator_version - The new value of the version instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter byte is not between 0 and 3.

getVersion

public byte getVersion()
Gets the value of the version instance variable.

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

setIsExtended

public void setIsExtended(byte pd_TransportCorrelator_isExtended)
Sets value of the isExtended instance variable to the specified value.

Parameters:
pd_TransportCorrelator_isExtended - The new value of the isExtended instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter byte is not between 0 and 1.

getIsExtended

public byte getIsExtended()
Gets the value of the isExtended instance variable.

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

setGUC_Length

public void setGUC_Length(byte[] pd_TransportCorrelator_guc_Length)
                   throws java.lang.IllegalArgumentException
Sets value of the guc_Length instance variable to the specified value.

Parameters:
pd_TransportCorrelator_guc_Length - The new value of the guc_Length instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter array's length is not 2.

getGUC_Length

public byte[] getGUC_Length()
Gets the value of the guc_Length instance variable.

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

setAdditionalCorrelatorSize

public void setAdditionalCorrelatorSize(byte[] pd_TransportCorrelator_additionalCorrelatorSize)
                                 throws java.lang.IllegalArgumentException
Sets value of the additionalCorrelatorSize instance variable to the specified value.

Parameters:
pd_TransportCorrelator_additionalCorrelatorSize - The new value of the additionalCorrelatorSize instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter array's length is not 2.

getAdditionalCorrelatorSize

public byte[] getAdditionalCorrelatorSize()
Gets the value of the additionalCorrelatorSize instance variable.

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

setLength

public void setLength(byte[] pd_TransportCorrelator_length)
               throws java.lang.IllegalArgumentException
Sets value of the length instance variable to the specified value.

Parameters:
pd_TransportCorrelator_length - The new value of the length instance variable.
Throws:
java.lang.IllegalArgumentException - if the parameter array's length is not 2.

getLength

public byte[] getLength()
Gets the value of the length instance variable.

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

setCorrelator_Format

public void setCorrelator_Format(byte pd_TransportCorrelator_correlator_Format)
Sets value of the correlator_Format instance variable to the specified value.

Parameters:
pd_TransportCorrelator_correlator_Format - The new value of the correlator_Format instance variable.

getCorrelator_Format

public byte getCorrelator_Format()
Gets the value of the correlator_Format instance variable.

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

setFlags

public void setFlags(byte pd_TransportCorrelator_flags)
Sets value of the flags instance variable to the specified value.

Parameters:
pd_TransportCorrelator_flags - The new value of the flags instance variable.

getFlags

public byte getFlags()
Gets the value of the flags instance variable.

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

setAdditionalCorrelatorInfoList

public void setAdditionalCorrelatorInfoList(PD_Additional_Correlator_Info[] pd_TransportCorrelator_additionalCorrelatorInfoList)
Sets value of the additionalCorrelatorInfoList instance variable to the specified value.

Parameters:
pd_TransportCorrelator_additionalCorrelatorInfoList - The new value of the additionalCorrelatorInfoList instance variable.

getAdditionalCorrelatorInfoList

public PD_Additional_Correlator_Info[] getAdditionalCorrelatorInfoList()
Gets the value of the additionalCorrelatorInfoList instance variable.

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

setGloballyUniqueCorrelatorValue

public void setGloballyUniqueCorrelatorValue(GloballyUniqueCorrelator pd_TransportCorrelator_globallyUniqueCorrelatorValue)
Sets value of the globallyUniqueCorrelatorValue instance variable to the specified value.

Parameters:
pd_TransportCorrelator_globallyUniqueCorrelatorValue - The new value of the globallyUniqueCorrelatorValue instance variable.

getGloballyUniqueCorrelatorValue

public GloballyUniqueCorrelator getGloballyUniqueCorrelatorValue()
Gets the value of the globallyUniqueCorrelatorValue instance variable.

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

setProcessCallingSequenceCounter

public void setProcessCallingSequenceCounter(long pd_TransportCorrelator_processCallingSequenceCounter)
Sets value of the processCallingSequenceCounter instance variable to the specified value.

Parameters:
pd_TransportCorrelator_processCallingSequenceCounter - The new value of the processCallingSequenceCounter instance variable.

getProcessCallingSequenceCounter

public long getProcessCallingSequenceCounter()
Gets the value of the processCallingSequenceCounter instance variable.

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

setThreadCallingSequenceCounter

public void setThreadCallingSequenceCounter(short pd_TransportCorrelator_threadCallingSequenceCounter)
Sets value of the threadCallingSequenceCounter instance variable to the specified value.

Parameters:
pd_TransportCorrelator_threadCallingSequenceCounter - The new value of the threadCallingSequenceCounter instance variable.

getThreadCallingSequenceCounter

public short getThreadCallingSequenceCounter()
Gets the value of the threadCallingSequenceCounter instance variable.

Returns:
The value of the threadCallingSequenceCounter instance variable, or null if the value of the threadCallingSequenceCounter 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.