Package org.snmp4j.smi
Class IpAddress
java.lang.Object
org.snmp4j.smi.AbstractVariable
org.snmp4j.smi.SMIAddress
org.snmp4j.smi.IpAddress
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable<Variable>
,BERSerializable
,Address
,AssignableFromByteArray
,AssignableFromString
,Variable
- Direct Known Subclasses:
TransportIpAddress
The
IpAddress
class represents an IPv4 address SNMP variable.- Since:
- 1.0
- Version:
- 1.10.3
- Author:
- Frank Fock
- See Also:
-
Field Summary
Fields inherited from class org.snmp4j.smi.AbstractVariable
SMISYNTAXES_PROPERTIES
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Clones this variable.int
void
decodeBER
(BERInputStream inputStream) Decodes aVariable
from anBERInputStream
.void
encodeBER
(OutputStream outputStream) Encodes aVariable
to anOutputStream
.boolean
void
fromSubIndex
(OID subIndex, boolean impliedLength) Sets the value of thisVariable
from the supplied (sub-)index.int
Returns the length of thisVariable
in bytes when encoded according to the Basic Encoding Rules (BER).int
Gets the ASN.1 syntax identifier value of this SNMP variable.int
hashCode()
boolean
isValid()
Checks whether thisAddress
is a valid transport address.static Address
Parses an IP address string and returns the correspondingIpAddress
instance.boolean
parseAddress
(String address) Parses the address from the supplied string representation.void
setAddress
(byte[] rawValue) void
setInetAddress
(InetAddress inetAddress) void
setValue
(byte[] value) Sets the value of this object from the supplied byte array.void
Sets the address value from the supplied String.byte[]
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.toString()
Gets a string representation of the variable.toSubIndex
(boolean impliedLength) Converts the value of thisVariable
to a (sub-)index value.Methods inherited from class org.snmp4j.smi.AbstractVariable
createFromBER, createFromSyntax, equal, getBERPayloadLength, getSyntaxFromString, getSyntaxString, getSyntaxString, isDynamic, isException
-
Field Details
-
ANY_IPADDRESS
-
-
Constructor Details
-
IpAddress
public IpAddress()Creates a0.0.0.0
IP address. -
IpAddress
Creates an IP address from anInetAddress
- Parameters:
address
- anInetAddress
instance (must not necessarily be a IPv4 address).
-
IpAddress
Create an IP address from an address string.- Parameters:
address
- an IP address String.- See Also:
-
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 Details
-
getSyntax
public int getSyntax()Description copied from class:AbstractVariable
Gets the ASN.1 syntax identifier value of this SNMP variable.- Specified by:
getSyntax
in interfaceVariable
- Specified by:
getSyntax
in classAbstractVariable
- Returns:
- an integer value less than 128 for regular SMI objects and a value greater or equal than 128 for exception values like noSuchObject, noSuchInstance, and endOfMibView.
-
isValid
public boolean isValid()Description copied from interface:Address
Checks whether thisAddress
is a valid transport address. -
toString
Description copied from class:AbstractVariable
Gets a string representation of the variable.- Specified by:
toString
in interfaceVariable
- Specified by:
toString
in classAbstractVariable
- Returns:
- a string representation of the variable's value.
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfaceVariable
- Specified by:
hashCode
in classAbstractVariable
-
parse
Parses an IP address string and returns the correspondingIpAddress
instance.- Parameters:
address
- an IP address string which may be a host name or a numerical IP address.- Returns:
- an
IpAddress
instance ornull
ifaddress
cannot not be parsed. - See Also:
-
parseAddress
Description copied from interface:Address
Parses the address from the supplied string representation.- Specified by:
parseAddress
in interfaceAddress
- Parameters:
address
- a String representation of this address.- Returns:
true
ifaddress
could be successfully parsed and has been assigned to this address object,false
otherwise.
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Variable>
- Specified by:
compareTo
in interfaceVariable
- Specified by:
compareTo
in classAbstractVariable
-
equals
- Specified by:
equals
in interfaceVariable
- Specified by:
equals
in classAbstractVariable
-
decodeBER
Description copied from class:AbstractVariable
Decodes aVariable
from anBERInputStream
.- Specified by:
decodeBER
in interfaceBERSerializable
- Specified by:
decodeBER
in classAbstractVariable
- Parameters:
inputStream
- anBERInputStream
containing a BER encoded byte stream.- Throws:
IOException
- if the stream could not be decoded by using BER rules.
-
encodeBER
Description copied from class:AbstractVariable
Encodes aVariable
to anOutputStream
.- Specified by:
encodeBER
in interfaceBERSerializable
- Specified by:
encodeBER
in classAbstractVariable
- Parameters:
outputStream
- anOutputStream
.- Throws:
IOException
- if an error occurs while writing to the stream.
-
getBERLength
public int getBERLength()Description copied from class:AbstractVariable
Returns the length of thisVariable
in bytes when encoded according to the Basic Encoding Rules (BER).- Specified by:
getBERLength
in interfaceBERSerializable
- Specified by:
getBERLength
in classAbstractVariable
- Returns:
- the BER encoded length of this variable.
-
setAddress
- Throws:
UnknownHostException
-
setInetAddress
-
getInetAddress
-
clone
Description copied from interface:Variable
Clones this variable. Cloning can be used by the SNMP4J API to better support concurrency by creating a clone for internal processing. The content of this object is independent to the content of the clone. Thus, changes to the clone will have no effect to this object.- Specified by:
clone
in interfaceVariable
- Specified by:
clone
in classAbstractVariable
- 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 interfaceVariable
- Specified by:
toInt
in classAbstractVariable
- 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 interfaceVariable
- Specified by:
toLong
in classAbstractVariable
- Returns:
- a long value.
-
toSubIndex
Description copied from class:AbstractVariable
Converts the value of thisVariable
to a (sub-)index value.- Specified by:
toSubIndex
in interfaceVariable
- Specified by:
toSubIndex
in classAbstractVariable
- Parameters:
impliedLength
- specifies if the sub-index has an implied length. This parameter applies to variable length variables only (e.g.OctetString
andOID
). For other variables it has no effect.- Returns:
- an OID that represents this value as an (sub-)index.
-
fromSubIndex
Description copied from class:AbstractVariable
Sets the value of thisVariable
from the supplied (sub-)index.- Specified by:
fromSubIndex
in interfaceVariable
- Specified by:
fromSubIndex
in classAbstractVariable
- 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
andOID
). For other variables it has no effect.
-
setValue
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 anIllegalArgumentException
runtime exception is thrown.- Specified by:
setValue
in interfaceAddress
- Specified by:
setValue
in interfaceAssignableFromString
- 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 interfaceAssignableFromByteArray
- 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 interfaceAssignableFromByteArray
- Returns:
- a byte array.
-