org.snmp4j.smi
Class IpAddress

java.lang.Object
  extended by org.snmp4j.smi.AbstractVariable
      extended by org.snmp4j.smi.SMIAddress
          extended by org.snmp4j.smi.IpAddress
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, BERSerializable, Address, AssignableFromByteArray, AssignableFromString, Variable
Direct Known Subclasses:
TransportIpAddress

public class IpAddress
extends SMIAddress
implements AssignableFromByteArray

The IpAddress class represents an IPv4 address SNMP variable.

Since:
1.0
Version:
1.10.3
Author:
Frank Fock
See Also:
Serialized Form

Field Summary
static java.net.InetAddress ANY_IPADDRESS
           
 
Fields inherited from class org.snmp4j.smi.AbstractVariable
SMISYNTAXES_PROPERTIES
 
Constructor Summary
IpAddress()
          Creates a 0.0.0.0 IP address.
IpAddress(byte[] addressBytes)
          Create an IP address from a raw IP address.
IpAddress(java.net.InetAddress address)
          Creates an IP address from an InetAddress
IpAddress(java.lang.String address)
          Create an IP address from an address string.
 
Method Summary
 java.lang.Object clone()
          Clones this variable.
 int compareTo(java.lang.Object o)
           
 void decodeBER(BERInputStream inputStream)
          Decodes a Variable from an InputStream.
 void encodeBER(java.io.OutputStream outputStream)
          Encodes a Variable to an OutputStream.
 boolean equals(java.lang.Object o)
           
 void fromSubIndex(OID subIndex, boolean impliedLength)
          Sets the value of this Variable from the supplied (sub-)index.
 int getBERLength()
          Returns the length of this Variable in bytes when encoded according to the Basic Encoding Rules (BER).
 java.net.InetAddress getInetAddress()
           
 int getSyntax()
          Gets the ASN.1 syntax identifier value of this SNMP variable.
 int hashCode()
           
 boolean isValid()
          Checks whether this Address is a valid transport address.
static Address parse(java.lang.String address)
          Parses an IP address string and returns the corresponding IpAddress instance.
 boolean parseAddress(java.lang.String address)
          Parses the address from the supplied string representation.
 void setAddress(byte[] rawValue)
           
 void setInetAddress(java.net.InetAddress inetAddress)
           
 void setValue(byte[] value)
          Sets the value of this object from the supplied byte array.
 void setValue(java.lang.String value)
          Sets the address value from the supplied String.
 byte[] toByteArray()
          Returns the value of this object as a byte array.
 int toInt()
          Returns an integer representation of this variable if such a representation exists.
 long toLong()
          Returns a long representation of this variable if such a representation exists.
 java.lang.String toString()
          Gets a string representation of the variable.
 OID toSubIndex(boolean impliedLength)
          Converts the value of this Variable to a (sub-)index value.
 
Methods inherited from class org.snmp4j.smi.AbstractVariable
createFromBER, createFromSyntax, getBERPayloadLength, getSyntaxFromString, getSyntaxString, getSyntaxString, isDynamic, isException
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ANY_IPADDRESS

public static final java.net.InetAddress ANY_IPADDRESS
Constructor Detail

IpAddress

public IpAddress()
Creates a 0.0.0.0 IP address.


IpAddress

public IpAddress(java.net.InetAddress address)
Creates an IP address from an InetAddress

Parameters:
address - an InetAddress instance (must not necessarily be a IPv4 address).

IpAddress

public IpAddress(java.lang.String address)
Create an IP address from an address string.

Parameters:
address - an IP address String.
See Also:
Address.parseAddress(String address)

IpAddress

public IpAddress(byte[] addressBytes)
Create an IP address from a raw IP address. The argument is in network byte order: the highest order byte of the address is in first element of the supplied byte array.

Parameters:
addressBytes - the raw IP address in network byte order.
Since:
1.10.2
Method Detail

getSyntax

public int getSyntax()
Description copied from class: AbstractVariable
Gets the ASN.1 syntax identifier value of this SNMP variable.

Specified by:
getSyntax in interface Variable
Specified by:
getSyntax in class AbstractVariable
Returns:
an integer value < 128 for regular SMI objects and a value >= 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.

isValid

public boolean isValid()
Description copied from interface: Address
Checks whether this Address is a valid transport address.

Specified by:
isValid in interface Address
Returns:
true if the address is valid, false otherwise.

toString

public java.lang.String toString()
Description copied from class: AbstractVariable
Gets a string representation of the variable.

Specified by:
toString in interface Variable
Specified by:
toString in class AbstractVariable
Returns:
a string representation of the variable's value.

hashCode

public int hashCode()
Specified by:
hashCode in interface Variable
Specified by:
hashCode in class AbstractVariable

parse

public static Address parse(java.lang.String address)
Parses an IP address string and returns the corresponding IpAddress instance.

Parameters:
address - an IP address string which may be a host name or a numerical IP address.
Returns:
an IpAddress instance or null if address cannot not be parsed.
See Also:
Address.parseAddress(String address)

parseAddress

public boolean parseAddress(java.lang.String address)
Description copied from interface: Address
Parses the address from the supplied string representation.

Specified by:
parseAddress in interface Address
Parameters:
address - a String representation of this address.
Returns:
true if address could be successfully parsed and has been assigned to this address object, false otherwise.

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable
Specified by:
compareTo in interface Variable
Specified by:
compareTo in class AbstractVariable

equals

public boolean equals(java.lang.Object o)
Specified by:
equals in interface Variable
Specified by:
equals in class AbstractVariable

decodeBER

public void decodeBER(BERInputStream inputStream)
               throws java.io.IOException
Description copied from class: AbstractVariable
Decodes a Variable from an InputStream.

Specified by:
decodeBER in interface BERSerializable
Specified by:
decodeBER in class AbstractVariable
Parameters:
inputStream - an InputStream containing a BER encoded byte stream.
Throws:
java.io.IOException - if the stream could not be decoded by using BER rules.

encodeBER

public void encodeBER(java.io.OutputStream outputStream)
               throws java.io.IOException
Description copied from class: AbstractVariable
Encodes a Variable to an OutputStream.

Specified by:
encodeBER in interface BERSerializable
Specified by:
encodeBER in class AbstractVariable
Parameters:
outputStream - an OutputStream.
Throws:
java.io.IOException - if an error occurs while writing to the stream.

getBERLength

public int getBERLength()
Description copied from class: AbstractVariable
Returns the length of this Variable in bytes when encoded according to the Basic Encoding Rules (BER).

Specified by:
getBERLength in interface BERSerializable
Specified by:
getBERLength in class AbstractVariable
Returns:
the BER encoded length of this variable.

setAddress

public void setAddress(byte[] rawValue)
                throws java.net.UnknownHostException
Throws:
java.net.UnknownHostException

setInetAddress

public void setInetAddress(java.net.InetAddress inetAddress)

getInetAddress

public java.net.InetAddress getInetAddress()

clone

public java.lang.Object clone()
Description copied from interface: Variable
Clones this variable. Cloning can be used by the SNMP4J API to better support concurrency by creating a immutable clone for internal processing.

Specified by:
clone in interface Variable
Specified by:
clone in class AbstractVariable
Returns:
a new instance of this Variable with the same value.

toInt

public int toInt()
Description copied from class: AbstractVariable
Returns an integer representation of this variable if such a representation exists.

Specified by:
toInt in interface Variable
Specified by:
toInt in class AbstractVariable
Returns:
an integer value (if the native representation of this variable would be a long, then the long value will be casted to int).

toLong

public long toLong()
Description copied from class: AbstractVariable
Returns a long representation of this variable if such a representation exists.

Specified by:
toLong in interface Variable
Specified by:
toLong in class AbstractVariable
Returns:
a long value.

toSubIndex

public OID toSubIndex(boolean impliedLength)
Description copied from class: AbstractVariable
Converts the value of this Variable to a (sub-)index value.

Specified by:
toSubIndex in interface Variable
Specified by:
toSubIndex in class AbstractVariable
Parameters:
impliedLength - specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g. OctetString and OID). For other variables it has no effect.
Returns:
an OID that represents this value as an (sub-)index.

fromSubIndex

public void fromSubIndex(OID subIndex,
                         boolean impliedLength)
Description copied from class: AbstractVariable
Sets the value of this Variable from the supplied (sub-)index.

Specified by:
fromSubIndex in interface Variable
Specified by:
fromSubIndex in class AbstractVariable
Parameters:
subIndex - the sub-index OID.
impliedLength - specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g. OctetString and OID). For other variables it has no effect.

setValue

public void setValue(java.lang.String value)
Description copied from interface: Address
Sets the address value from the supplied String. The string must match the format required for the Address instance implementing this interface. Otherwise an IllegalArgumentException runtime exception is thrown.

Specified by:
setValue in interface Address
Specified by:
setValue in interface AssignableFromString
Parameters:
value - an address String.

setValue

public void setValue(byte[] value)
Description copied from interface: AssignableFromByteArray
Sets the value of this object from the supplied byte array.

Specified by:
setValue in interface AssignableFromByteArray
Parameters:
value - a byte array.

toByteArray

public byte[] toByteArray()
Description copied from interface: AssignableFromByteArray
Returns the value of this object as a byte array.

Specified by:
toByteArray in interface AssignableFromByteArray
Returns:
a byte array.

Copyright 2005-2010 Frank Fock (SNMP4J.org)

Copyright © 2011 SNMP4J.org. All Rights Reserved.