|
|||||||||||
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_Additional_Correlator_Info
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 class consists of name (ID) /value (Correlator) pair that will hold the extra correlation information required to be carried over the wire by the applications. For example, the PMIRequestMetrics request counter can be added as follow: CorrelatorID=PMIRequestMetrics Correlator=7. Another example, the eWLM correlator can be added as follow: CorrelatorID=eWLM Correlator=eWLMCorrelator. (Mandatory only if the IsExtended bit is set.) 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_Additional_Correlator_Info()
PD_Additional_Correlator_Info constructors |
Method Summary | |
---|---|
byte[] |
getCorrelator_Length()
Gets the value of the correlator_Length instance variable. |
byte[] |
getCorrelator()
Gets the value of the correlator instance variable. |
byte |
getCorrelatorID_Length()
Gets the value of the correlatorID_Length instance variable. |
byte[] |
getCorrelatorID()
Gets the value of the correlatorID 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 |
setCorrelator_Length(byte[] pd_Additional_correlator_Length_Info_correlator_Length)
Sets value of the correlator_Length instance variable to the specified value. |
void |
setCorrelator(byte[] pd_Additional_Correlator_Info_correlator)
Sets value of the correlator instance variable to the specified value. |
void |
setCorrelatorID_Length(byte pd_Additional_Correlator_Info_correlatorID_Length)
Sets value of the correlatorID_Length instance variable to the specified value. |
void |
setCorrelatorID(byte[] pd_Additional_Correlator_Info_correlatorID)
Sets value of the correlatorID 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_Additional_Correlator_Info()
Method Detail |
public java.lang.String getUniqueInstanceID()
public void setCorrelatorID(byte[] pd_Additional_Correlator_Info_correlatorID) throws java.lang.IllegalArgumentException
pd_Additional_Correlator_Info_correlatorID
- The new value of the correlatorID instance variable.
java.lang.IllegalArgumentException
- if the parameter array's length is greater than 16.public byte[] getCorrelatorID()
null
if the value of the correlatorID instance variable has not been set or is set to null
.public void setCorrelatorID_Length(byte pd_Additional_Correlator_Info_correlatorID_Length)
pd_Additional_Correlator_Info_correlatorID_Length
- The new value of the correlatorID_Length instance variable.public byte getCorrelatorID_Length()
null
if the value of the correlatorID_Length instance variable has not been set or is set to null
.public void setCorrelator(byte[] pd_Additional_Correlator_Info_correlator) throws java.lang.IllegalArgumentException
pd_Additional_Correlator_Info_correlator
- The new value of the correlator instance variable.
java.lang.IllegalArgumentException
- if the parameter array's length is not 504.public byte[] getCorrelator()
null
if the value of the correlator instance variable has not been set or is set to null
.public void setCorrelator_Length(byte[] pd_Additional_correlator_Length_Info_correlator_Length) throws java.lang.IllegalArgumentException
pd_Additional_correlator_Length_Info_correlator_Length
- The new value of the correlator_Length instance variable.
java.lang.IllegalArgumentException
- if the parameter array's length is not 2.public byte[] getCorrelator_Length()
null
if the value of the correlator_Length 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 |