SnmpEngineId (Java SE 6 Javadoc and Source)

java.lang.Object
- com.sun.jmx.snmp.SnmpEngineId

All Implemented Interfaces:

Serializable
```
public class SnmpEngineId
extends Object
implements Serializable
```
This class is handling an SnmpEngineId data. It copes with binary as well as String representation of an engine Id. A string format engine is an hex string starting with 0x.
This API is a Sun Microsystems internal API and is subject to change without notice.

Since:

1.5

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

(package private) byte[] engineId

(package private) String hexString

(package private) String humanString

Fields
Modifier and Type	Field and Description
`(package private) byte[]`	`engineId`
`(package private) String`	`hexString`
`(package private) String`	`humanString`

Constructor Summary

Constructors
Constructor and Description

SnmpEngineId(byte[] bin)
New SnmpEngineId with a binary value.

SnmpEngineId(String hexString)
New SnmpEngineId with an hex string value.

Constructors
Constructor and Description
`SnmpEngineId(byte[] bin)` New `SnmpEngineId` with a binary value.
`SnmpEngineId(String hexString)` New `SnmpEngineId` with an hex string value.

Method Summary

Methods
Modifier and Type	Method and Description
`static SnmpEngineId`	`createEngineId()` Generates an engine Id that is unique to the host the agent is running on.
`static SnmpEngineId`	`createEngineId(byte[] arr)` Generates an engine Id based on the passed array.
`static SnmpEngineId`	`createEngineId(InetAddress addr)` Generates an engine Id based on an InetAddress.
`static SnmpEngineId`	`createEngineId(InetAddress address, int port)` Generates a unique engine Id.
`static SnmpEngineId`	`createEngineId(InetAddress addr, int port, int iana)` Generates a unique engine Id.
`static SnmpEngineId`	`createEngineId(int port)` Generates a unique engine Id.
`static SnmpEngineId`	`createEngineId(int iana, InetAddress addr)` Generates an engine Id based on an InetAddress.
`static SnmpEngineId`	`createEngineId(int port, int iana)` Generates a unique engine Id.
`static SnmpEngineId`	`createEngineId(String str)` Generates a unique engine Id.
`static SnmpEngineId`	`createEngineId(String str, String separator)` Idem { @link com.sun.jmx.snmp.SnmpEngineId#createEngineId(java.lang.String) } with the ability to provide your own separator.
`boolean`	`equals(Object a)` Tests `SnmpEngineId` instance equality.
`byte[]`	`getBytes()` Returns a binary engine Id.
`String`	`getReadableId()` If a string of the format <address>:<port>:<IANA number> has been provided at creation time, this string is returned.
`int`	`hashCode()` Returns a hash code value for the object.
`(package private) void`	`setStringValue(String val)` In order to store the string used to create the engineId.
`SnmpOid`	`toOid()` Translates an engine Id in an SnmpOid format.
`String`	`toString()` Returns a string format engine Id.
`(package private) static void`	`validateId(byte[] arr)`
`(package private) static void`	`validateId(String str)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - engineId
```
byte[] engineId
```
  - hexString
```
String hexString
```
  - humanString
```
String humanString
```
- Constructor Detail
  - SnmpEngineId
```
SnmpEngineId(String hexString)
```
    New SnmpEngineId with an hex string value. Can handle engine Id format <host>:<port>.
    
    Parameters:
    hexString - Hexa string.
  - SnmpEngineId
```
SnmpEngineId(byte[] bin)
```
    New SnmpEngineId with a binary value. You can use SnmpTools to convert from hex string to binary format.
    
    Parameters:
    bin - Binary value
- Method Detail
  - getReadableId
```
public String getReadableId()
```
    If a string of the format <address>:<port>:<IANA number> has been provided at creation time, this string is returned.
    
    Returns:
    The Id as a readable string or null if not provided.
  - toString
```
public String toString()
```
    Returns a string format engine Id.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String format value.
  - getBytes
```
public byte[] getBytes()
```
    Returns a binary engine Id.
    
    Returns:
    Binary value.
  - setStringValue
```
void setStringValue(String val)
```
    In order to store the string used to create the engineId.
  - validateId
```
static void validateId(String str)
                throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - validateId
```
static void validateId(byte[] arr)
                throws IllegalArgumentException
```
    Throws:
    
    IllegalArgumentException
  - createEngineId
```
public static SnmpEngineId createEngineId(byte[] arr)
                                   throws IllegalArgumentException
```
    Generates an engine Id based on the passed array.
    Returns:
    The created engine Id or null if given arr is null or its length == 0;
    
    Throws:
    IllegalArgumentException - when:
    
    octet string lower than 5 bytes.
    
    octet string greater than 32 bytes.
    
    octet string = all zeros.
    
    octet string = all 'ff'H.
    
    octet strings with very first bit = 0 and length != 12 octets
  - createEngineId
```
public static SnmpEngineId createEngineId()
```
    Generates an engine Id that is unique to the host the agent is running on. The engine Id unicity is system time based. The creation algorithm uses the SUN Microsystems IANA number (42).
    
    Returns:
    The generated engine Id.
  - toOid
```
public SnmpOid toOid()
```
    Translates an engine Id in an SnmpOid format. This is useful when dealing with USM MIB indexes. The oid format is : ...... Eg: "0x8000002a05819dcb6e00001f96" ==> 13.128.0.0.42.5.129.157.203.110.0.0.31.150
    
    Returns:
    SnmpOid The oid.
  - createEngineId
```
public static SnmpEngineId createEngineId(String str)
                                   throws IllegalArgumentException,
                                          UnknownHostException
```
    Generates a unique engine Id. Hexadecimal strings as well as a textual description are supported. The textual format is as follow:
    <address>:<port>:<IANA number>
    
    The allowed formats :
    - <address>:<port>:<IANA number>
      All these parameters are used to generate the Id. WARNING, this method is not compliant with IPv6 address format. Use { @link com.sun.jmx.snmp.SnmpEngineId#createEngineId(java.lang.String,java.lang.String) } instead.
    - <address>:<port>
      The IANA number will be the SUN Microsystems one (42).
    - address
      The port 161 will be used to generate the Id. IANA number will be the SUN Microsystems one (42).
    - :port
      The host to use is localhost. IANA number will be the SUN Microsystems one (42).
    - ::<IANA number>
      The port 161 and localhost will be used to generate the Id.
    - :<port>:<IANA number>
      The host to use is localhost.
    - <address>::<IANA number>
      The port 161 will be used to generate the Id.
    - ::
      The port 161, localhost and the SUN Microsystems IANA number will be used to generate the Id.
    Parameters:
    str - The string to parse.
    
    Returns:
    The generated engine Id or null if the passed string is null.
    
    Throws:
    
    UnknownHostException - if the host name contained in the textual format is unknown.
    IllegalArgumentException - when :
    
    octet string lower than 5 bytes.
    
    octet string greater than 32 bytes.
    
    octet string = all zeros.
    
    octet string = all 'ff'H.
    
    octet strings with very first bit = 0 and length != 12 octets
    
    An IPv6 address format is used in conjonction with the ":" separator
  - createEngineId
```
public static SnmpEngineId createEngineId(String str,
                          String separator)
                                   throws IllegalArgumentException,
                                          UnknownHostException
```
    Idem { @link com.sun.jmx.snmp.SnmpEngineId#createEngineId(java.lang.String) } with the ability to provide your own separator. This allows IPv6 address format handling (eg: providing @ as separator).
    Parameters:
    str - The string to parse.
    separator - the separator to use. If null is provided, the default separator ":" is used.
    
    Returns:
    The generated engine Id or null if the passed string is null.
    
    Throws:
    
    UnknownHostException - if the host name contained in the textual format is unknown.
    IllegalArgumentException - when :
    
    octet string lower than 5 bytes.
    
    octet string greater than 32 bytes.
    
    octet string = all zeros.
    
    octet string = all 'ff'H.
    
    octet strings with very first bit = 0 and length != 12 octets
    
    An IPv6 address format is used in conjonction with the ":" separator
    Since:
    
    1.5
  - createEngineId
```
public static SnmpEngineId createEngineId(int port)
                                   throws UnknownHostException
```
    Generates a unique engine Id. The engine Id unicity is based on the host IP address and port. The IP address used is the localhost one. The creation algorithm uses the SUN Microsystems IANA number (42).
    
    Parameters:
    port - The TCP/IP port the SNMPv3 Adaptor Server is listening to.
    
    Returns:
    The generated engine Id.
    
    Throws:
    
    UnknownHostException - if the local host name used to calculate the id is unknown.
  - createEngineId
```
public static SnmpEngineId createEngineId(InetAddress address,
                          int port)
                                   throws IllegalArgumentException
```
    Generates a unique engine Id. The engine Id unicity is based on the host IP address and port. The IP address used is the passed one. The creation algorithm uses the SUN Microsystems IANA number (42).
    
    Parameters:
    address - The IP address the SNMPv3 Adaptor Server is listening to.
    port - The TCP/IP port the SNMPv3 Adaptor Server is listening to.
    
    Returns:
    The generated engine Id.
    
    Throws:
    
    UnknownHostException. - if the provided address is null.
    
    IllegalArgumentException
  - createEngineId
```
public static SnmpEngineId createEngineId(int port,
                          int iana)
                                   throws UnknownHostException
```
    Generates a unique engine Id. The engine Id unicity is based on the host IP address and port. The IP address is the localhost one. The creation algorithm uses the passed IANA number.
    
    Parameters:
    port - The TCP/IP port the SNMPv3 Adaptor Server is listening to.
    iana - Your enterprise IANA number.
    
    Returns:
    The generated engine Id.
    
    Throws:
    
    UnknownHostException - if the local host name used to calculate the id is unknown.
  - createEngineId
```
public static SnmpEngineId createEngineId(InetAddress addr,
                          int port,
                          int iana)
```
    Generates a unique engine Id. The engine Id unicity is based on the host IP address and port. The IP address is the passed one, it handles IPv4 and IPv6 hosts. The creation algorithm uses the passed IANA number.
    
    Parameters:
    addr - The IP address the SNMPv3 Adaptor Server is listening to.
    port - The TCP/IP port the SNMPv3 Adaptor Server is listening to.
    iana - Your enterprise IANA number.
    
    Returns:
    The generated engine Id.
    
    Throws:
    
    UnknownHostException - if the provided InetAddress is null.
  - createEngineId
```
public static SnmpEngineId createEngineId(int iana,
                          InetAddress addr)
```
    Generates an engine Id based on an InetAddress. Handles IPv4 and IPv6 addresses. The creation algorithm uses the passed IANA number.
    
    Parameters:
    iana - Your enterprise IANA number.
    addr - The IP address the SNMPv3 Adaptor Server is listening to.
    
    Returns:
    The generated engine Id.
    
    Throws:
    
    UnknownHostException - if the provided InetAddress is null.
    Since:
    
    1.5
  - createEngineId
```
public static SnmpEngineId createEngineId(InetAddress addr)
```
    Generates an engine Id based on an InetAddress. Handles IPv4 and IPv6 addresses. The creation algorithm uses the sun IANA number (42).
    
    Parameters:
    addr - The IP address the SNMPv3 Adaptor Server is listening to.
    
    Returns:
    The generated engine Id.
    
    Throws:
    
    UnknownHostException - if the provided InetAddress is null.
    Since:
    
    1.5
  - equals
```
public boolean equals(Object a)
```
    Tests SnmpEngineId instance equality. Two SnmpEngineId are equal if they have the same value.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    a - the reference object with which to compare.
    
    Returns:
    true if the two SnmpEngineId are equals, false otherwise.
    See Also:
    Object.hashCode(), Hashtable
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java^TM programming language.)
    Overrides:
    
    hashCode in class Object
    
    Returns:
    a hash code value for this object.
    See Also:
    Object.equals(java.lang.Object), Hashtable

Class SnmpEngineId [ source ]

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

engineId

hexString

humanString

Constructor Detail

SnmpEngineId

SnmpEngineId

Method Detail

getReadableId

toString

getBytes

setStringValue

validateId

validateId

createEngineId

createEngineId

toOid

createEngineId

createEngineId

createEngineId

createEngineId

createEngineId

createEngineId

createEngineId

createEngineId

equals

hashCode