org.opengroup.arm40.transaction
Interface ArmCorrelator
- All Superinterfaces:
- ArmInterface, ArmToken
- All Known Implementing Classes:
- ArmCorrelator
public interface ArmCorrelator
- extends ArmToken
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. A correlator contains a two-byte length field,
a one-byte format ID, a one-byte flag field, plus it may contain other data
that is used to uniquely identify an instance of a transaction.
Applications do not need to understand correlator internals. See
Appendix B of the ARM 4.0 Java Binding Specification for more
information about correlator formats.
A correlation token is a maximum of
ArmConstants.CORR_MAX_LENGTH
bytes, including the header.
ArmCorrelator
is created in one of three ways:
An application may extract the byte array in network byte order, which
is the format needed to send to a called transaction, using the
copyBytes()
or getBytes()
methods of
ArmToken
, ArmCorrelator
's parent interface.
Implementations of this interface should also override
equals()
and hashCode()
from
java.lang.Object
.
- Author:
- ARM Working Group of The Open Group
Method Summary |
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. |
isAgentTrace
boolean isAgentTrace()
- indicates whether the "agent trace" flag is on in the correlator.
- Returns:
- the status of the agent trace flag.
isApplicationTrace
boolean isApplicationTrace()
- indicates whether the "application trace" flag is on in the
correlator.
- Returns:
- the status of the application trace flag.