org.arm4.arm40.transaction
Class ArmCorrelator

java.lang.Object
  extended by org.arm4.arm40.transaction.ArmInterface
      extended by org.arm4.arm40.transaction.ArmToken
          extended by org.arm4.arm40.transaction.ArmCorrelator
All Implemented Interfaces:
ArmCorrelator, ArmInterface, ArmToken

public class ArmCorrelator
extends ArmToken
implements ArmCorrelator

ArmCorrelator represents a correlation token passed from a calling transaction to a called transaction. The correlation token may be used to establish a calling hierarchy across processes and systems. ArmCorrelator is created using one of these methods:

Version:
$Revision$ $Date$
Author:
dcarter

Field Summary
 
Fields inherited from class org.arm4.arm40.transaction.ArmToken
HASHKEY_MAX, m_hashkey, m_hashkeyGenerated, m_tokenData
 
Fields inherited from class org.arm4.arm40.transaction.ArmInterface
m_errorCode, m_factory
 
Constructor Summary
ArmCorrelator(byte[] id)
          Create the ARM Correlator.
ArmCorrelator(byte[] id, int offset)
          Create the ARM Correlator.
 
Method Summary
 boolean equals(java.lang.Object obj)
           
 boolean isAgentTrace()
          indicates whether the "agent trace" flag is on in the correlator.
 boolean isApplicationTrace()
          indicates whether the "application trace" flag is on in the correlator.
 
Methods inherited from class org.arm4.arm40.transaction.ArmToken
compare, copyBytes, copyBytes, getByte, getBytes, getLength, hashCode
 
Methods inherited from class org.arm4.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmToken
copyBytes, copyBytes, getBytes, getLength
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Constructor Detail

ArmCorrelator

public ArmCorrelator(byte[] id)
Create the ARM Correlator.

Parameters:
id -

ArmCorrelator

public ArmCorrelator(byte[] id,
                     int offset)
Create the ARM Correlator.

Parameters:
id -
offset -
Method Detail

isAgentTrace

public boolean isAgentTrace()
Description copied from interface: ArmCorrelator
indicates whether the "agent trace" flag is on in the correlator.

Specified by:
isAgentTrace in interface ArmCorrelator
Returns:
the status of the agent trace flag.

isApplicationTrace

public boolean isApplicationTrace()
Description copied from interface: ArmCorrelator
indicates whether the "application trace" flag is on in the correlator.

Specified by:
isApplicationTrace in interface ArmCorrelator
Returns:
the status of the application trace flag.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object