org.arm4.arm40.tranreport
Class ArmSystemAddress

java.lang.Object
  org.arm4.arm40.transaction.ArmInterface
      org.arm4.arm40.transaction.ArmToken
          org.arm4.arm40.tranreport.ArmSystemAddress

All Implemented Interfaces:

ArmSystemAddress, ArmInterface, ArmToken

public class ArmSystemAddress
extends ArmToken
implements ArmSystemAddress

Encapsulates the network addressing information for a system. It may be used with ArmTranReport if the reported transaction executed on a different system.

• Address. The system address is the network name or address of the system, as it would be sent in a data frame across a network in network byte order.
• Format. The format of the system address, such as an SNA address or a hostname. See the description of format constants defined in this interface for available formats and the mapping of the address bytes supplied.
  Note that all positive integer values not defined as constant are reserved for future definitions. Currently, this pplies to values 9:32767. All negative values are available for implementation-defined use.
• ID. An optional 16-byte ID associated with the format and address, if any. The ID value is bound to a unique combination of the format and address. When provided, the ID may be used as a concise alias for the unique combination. It may be null.

  The fields are set using the newArmSystemAddress() method of ArmTranReportFactory or the getArmSystemAddress() method of ArmSystem. There are no setter methods for the individual fields. The object is immutable.

  Implementations of this interface should also override equals() and hashCode() from java.lang.Object.

  equals(Object obj), a method inherited from java.lang.Object, returns true if the internal data is byte-for-byte identical in two objects. For example, a.equals(b) returns true if and only if:

  • Both a and b implement ArmSystemAddress.
  • The inherited methods a.getBytes() and b.getBytes() would return byte arrays of identical lengths and contents.
  • a.getFormat() and b.getFormat() would return identical values.

  Objects implementing this interface are created using ArmTranReportFactory.newArmSystemAddress(short, byte[], org.opengroup.arm40.transaction.ArmID).

  Version:

  $Revision$ $Date$

  Author:

  dcarter

  Field Summary

  static short	FORMAT_HOSTNAME
  static short	FORMAT_IPV4
  static short	FORMAT_IPV4PORT
  static short	FORMAT_IPV6
  static short	FORMAT_IPV6PORT
  static short	FORMAT_SNA
  static short	FORMAT_UUID
  static short	FORMAT_X25
  protected short	m_addressFormat
  protected ArmID	m_addressId

  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

  ArmSystemAddress(short format, byte[] addressBytes, ArmID id)
  Create ARM System Address.

  ArmSystemAddress(short format, byte[] addressBytes, int offset, ArmID id)
  Create ARM System Address.

  ArmSystemAddress(short format, byte[] addressBytes, int offset, int length, ArmID id)
  Create ARM System Address.

  Method Summary

  byte[]	getAddress()
  short	getFormat()
  ArmID	getID()

  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, equals, 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

  Field Detail

  FORMAT_IPV4

  public static final short FORMAT_IPV4

  See Also:

  Constant Field Values

  FORMAT_IPV4PORT

  public static final short FORMAT_IPV4PORT

  See Also:

  Constant Field Values

  FORMAT_IPV6

  public static final short FORMAT_IPV6

  See Also:

  Constant Field Values

  FORMAT_IPV6PORT

  public static final short FORMAT_IPV6PORT

  See Also:

  Constant Field Values

  FORMAT_SNA

  public static final short FORMAT_SNA

  See Also:

  Constant Field Values

  FORMAT_X25

  public static final short FORMAT_X25

  See Also:

  Constant Field Values

  FORMAT_HOSTNAME

  public static final short FORMAT_HOSTNAME

  See Also:

  Constant Field Values

  FORMAT_UUID

  public static final short FORMAT_UUID

  See Also:

  Constant Field Values

  m_addressFormat

  protected short m_addressFormat

  m_addressId

  protected ArmID m_addressId

  Constructor Detail

  ArmSystemAddress

  public ArmSystemAddress(short format,
                          byte[] addressBytes,
                          ArmID id)

  Create ARM System Address.

  Parameters:

  format -

  addressBytes -

  id -

  ArmSystemAddress

  public ArmSystemAddress(short format,
                          byte[] addressBytes,
                          int offset,
                          ArmID id)

  Create ARM System Address.

  Parameters:

  format -

  addressBytes -

  offset -

  id -

  ArmSystemAddress

  public ArmSystemAddress(short format,
                          byte[] addressBytes,
                          int offset,
                          int length,
                          ArmID id)

  Create ARM System Address.

  Parameters:

  format -

  addressBytes -

  offset -

  length -

  id -

  Method Detail

  getAddress

  public byte[] getAddress()

  Specified by:

  getAddress in interface ArmSystemAddress

  Returns:

  a byte array containing the address. The returned value is the same value passed to the newArmSystemAddress() method of ArmTranReportFactory.

  getFormat

  public short getFormat()

  Specified by:

  getFormat in interface ArmSystemAddress

  Returns:

  a short containing the format. The returned value is the same value passed to the newArmSystemAddress() method of ArmTranReportFactory.

  getID

  public ArmID getID()

  Specified by:

  getID in interface ArmSystemAddress

  Returns:

  the optional 16-byte ID associated with the format and address, if any. The returned value, which could be null, is the same value passed to the newArmSystemAddress() method of ArmTranReportFactory.