org.opengroup.arm40.tranreport.ArmSystemAddress Interface Reference
[ARM 4.0 Applications]
Encapsulates the network addressing information for a system. More...
Public Member Functions | |
byte[] | getAddress () |
short | getFormat () |
ArmID | getID () |
Static Public Attributes | |
static final short | FORMAT_HOSTNAME = 7 |
a hostname (characters, not null-terminated). | |
static final short | FORMAT_IPV4 = 1 |
an IPv4 address. | |
static final short | FORMAT_IPV4PORT = 2 |
an IPv4 address and port number. | |
static final short | FORMAT_IPV6 = 3 |
an IPv6 address. | |
static final short | FORMAT_IPV6PORT = 4 |
an IPv6 address and port number. | |
static final short | FORMAT_SNA = 5 |
an SNA address. | |
static final short | FORMAT_X25 = 6 |
an X.25 address. | |
static final short | FORMAT_UUID = 8 |
a Universally-unique ID. |
Detailed Description
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
andb
implementArmSystemAddress
. -
The inherited methods
a.getBytes()
andb.getBytes()
would return byte arrays of identical lengths and contents. -
a.getFormat()
andb.getFormat()
would return identical values.
Objects implementing this interface are created using ArmTranReportFactory#newArmSystemAddress.
Member Function Documentation
byte [] org.opengroup.arm40.tranreport.ArmSystemAddress.getAddress | ( | ) |
- Returns:
- a byte array containing the address. The returned value is the same value passed to the
newArmSystemAddress()
method ofArmTranReportFactory
.
short org.opengroup.arm40.tranreport.ArmSystemAddress.getFormat | ( | ) |
- Returns:
- a short containing the format. The returned value is the same value passed to the
newArmSystemAddress()
method ofArmTranReportFactory
.
ArmID org.opengroup.arm40.tranreport.ArmSystemAddress.getID | ( | ) |
- 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 ofArmTranReportFactory
.
Member Data Documentation
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_HOSTNAME = 7 [static] |
a hostname (characters, not null-terminated).
Bytes 0:?? = hostname
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_IPV4 = 1 [static] |
an IPv4 address.
Bytes 0:3 = 4-byte IP address.
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_IPV4PORT = 2 [static] |
an IPv4 address and port number.
Bytes 0:3 = 4-byte IP address
Bytes 4:5 = 2-byte IP port number
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_IPV6 = 3 [static] |
an IPv6 address.
Bytes 0:15 = 16-byte IP address
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_IPV6PORT = 4 [static] |
an IPv6 address and port number.
Bytes 0:15 = 16-byte IP address
Bytes 16:17 = 2-byte IP port number
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_SNA = 5 [static] |
an SNA address.
Bytes 0:7 = EBCDIC-encoded network ID
Bytes 8:15 = EBCDIC-encoded network accessible unit (control point or LU)
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_UUID = 8 [static] |
a Universally-unique ID.
Bytes 0:15 = UUID in binary. This is useful for applications that define their system by a UUID rather than a network address or hostname or some other address form.
final short org.opengroup.arm40.tranreport.ArmSystemAddress.FORMAT_X25 = 6 [static] |
an X.25 address.
Bytes 0:15 = The X.25 address (also referred to as an X.121 address). This is up to 16 ASCII character digits ranging from 0-9.
The documentation for this interface was generated from the following file:
- org/opengroup/arm40/tranreport/ArmSystemAddress.java