|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.etools.logging.pd.artifacts.PD_TransportCorrelator
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 |
public PD_TransportCorrelator(GloballyUniqueCorrelator pd_TransportCorrelator_globallyUniqueCorrelatorValue)
Method Detail |
public java.lang.String getUniqueInstanceID()
public void setReserved(byte pd_TransportCorrelator_reserved)
pd_TransportCorrelator_reserved
- The new value of the reserved instance variable.
java.lang.IllegalArgumentException
- if the parameter byte is not between 0 and 1.public byte getReserved()
null
if the value of the reserved instance variable has not been set or is set to null
.public void setType(byte pd_TransportCorrelator_type)
pd_TransportCorrelator_type
- The new value of the type instance variable.
java.lang.IllegalArgumentException
- if the parameter byte is not between 0 and 15.public byte getType()
null
if the value of the type instance variable has not been set or is set to null
.public void setVersion(byte pd_TransportCorrelator_version)
pd_TransportCorrelator_version
- The new value of the version instance variable.
java.lang.IllegalArgumentException
- if the parameter byte is not between 0 and 3.public byte getVersion()
null
if the value of the version instance variable has not been set or is set to null
.public void setIsExtended(byte pd_TransportCorrelator_isExtended)
pd_TransportCorrelator_isExtended
- The new value of the isExtended instance variable.
java.lang.IllegalArgumentException
- if the parameter byte is not between 0 and 1.public byte getIsExtended()
null
if the value of the isExtended instance variable has not been set or is set to null
.public void setGUC_Length(byte[] pd_TransportCorrelator_guc_Length) throws java.lang.IllegalArgumentException
pd_TransportCorrelator_guc_Length
- The new value of the guc_Length instance variable.
java.lang.IllegalArgumentException
- if the parameter array's length is not 2.public byte[] getGUC_Length()
null
if the value of the guc_Length instance variable has not been set or is set to null
.public void setAdditionalCorrelatorSize(byte[] pd_TransportCorrelator_additionalCorrelatorSize) throws java.lang.IllegalArgumentException
pd_TransportCorrelator_additionalCorrelatorSize
- The new value of the additionalCorrelatorSize instance variable.
java.lang.IllegalArgumentException
- if the parameter array's length is not 2.public byte[] getAdditionalCorrelatorSize()
null
if the value of the additionalCorrelatorSize instance variable has not been set or is set to null
.public void setLength(byte[] pd_TransportCorrelator_length) throws java.lang.IllegalArgumentException
pd_TransportCorrelator_length
- The new value of the length instance variable.
java.lang.IllegalArgumentException
- if the parameter array's length is not 2.public byte[] getLength()
null
if the value of the length instance variable has not been set or is set to null
.public void setCorrelator_Format(byte pd_TransportCorrelator_correlator_Format)
pd_TransportCorrelator_correlator_Format
- The new value of the correlator_Format instance variable.public byte getCorrelator_Format()
null
if the value of the correlator_Format instance variable has not been set or is set to null
.public void setFlags(byte pd_TransportCorrelator_flags)
pd_TransportCorrelator_flags
- The new value of the flags instance variable.public byte getFlags()
null
if the value of the flags instance variable has not been set or is set to null
.public void setAdditionalCorrelatorInfoList(PD_Additional_Correlator_Info[] pd_TransportCorrelator_additionalCorrelatorInfoList)
pd_TransportCorrelator_additionalCorrelatorInfoList
- The new value of the additionalCorrelatorInfoList instance variable.public PD_Additional_Correlator_Info[] getAdditionalCorrelatorInfoList()
null
if the value of the additionalCorrelatorInfoList instance variable has not been set or is set to null
.public void setGloballyUniqueCorrelatorValue(GloballyUniqueCorrelator pd_TransportCorrelator_globallyUniqueCorrelatorValue)
pd_TransportCorrelator_globallyUniqueCorrelatorValue
- The new value of the globallyUniqueCorrelatorValue instance variable.public GloballyUniqueCorrelator getGloballyUniqueCorrelatorValue()
null
if the value of the globallyUniqueCorrelatorValue instance variable has not been set or is set to null
.public void setProcessCallingSequenceCounter(long pd_TransportCorrelator_processCallingSequenceCounter)
pd_TransportCorrelator_processCallingSequenceCounter
- The new value of the processCallingSequenceCounter instance variable.public long getProcessCallingSequenceCounter()
null
if the value of the processCallingSequenceCounter instance variable has not been set or is set to null
.public void setThreadCallingSequenceCounter(short pd_TransportCorrelator_threadCallingSequenceCounter)
pd_TransportCorrelator_threadCallingSequenceCounter
- The new value of the threadCallingSequenceCounter instance variable.public short getThreadCallingSequenceCounter()
null
if the value of the threadCallingSequenceCounter instance variable has not been set or is set to null
.public java.lang.String toCanonicalXMLString()
public void regenerateUniqueInstanceID()
public void init()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |