org.friendlysnmp

Class FConverter

java.lang.Object

org.friendlysnmp.FConverter

public class FConverter
extends java.lang.Object

This class contains collection of static methods to convert java.lang objects to and from org.snmp4j.smi.Variable

The code is based on converter used in SNMP-FD - Failure Detection service based on SNMP by Matthias Wiesmann ((dead links below) http://ddg.jaist.ac.jp/en/projects/snmp-fd/ http://ddsg.jaist.ac.jp/~wiesmann/share/snmp4j-extensions http://ddsg.jaist.ac.jp/~wiesmann/share/snmp4j-extensions/Extensions.jar

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	defaultJavaValue(int syntax) Returns default values of different types, like 0 for numbers, empty string, 0.0.0.0 for IP address.
static org.snmp4j.smi.OctetString	parseBITS16(int val) Parses 16 bit integer to OctetString
static org.snmp4j.smi.OctetString	parseBITS32(int val) Parses 32 bit integer to OctetString
static org.snmp4j.smi.OctetString	parseBITS64(long val) Parses 64 bit integer to OctetString
static org.snmp4j.smi.Counter32	parseCounter32(java.lang.Object obj) Parses Long or String to Counter32.
static org.snmp4j.smi.Counter64	parseCounter64(java.lang.Object obj) Parses Long or String to Counter64.
static org.snmp4j.smi.Integer32	parseInteger32(java.lang.Object obj) Parses Integer or String to Integer32.
static org.snmp4j.smi.IpAddress	parseIpAddress(java.lang.Object obj) Parses InetAddress or String to IpAddress.
static org.snmp4j.smi.OID	parseOID(java.lang.Object obj) Parses Number[], int[] or String to OID.
static org.snmp4j.smi.TimeTicks	parseTimeTicks(java.lang.Object obj) Parses Long or String to TimeTicks.
static org.snmp4j.smi.UnsignedInteger32	parseUnsignedInteger32(java.lang.Object obj, int syntax) Parses Long or String to UnsignedInteger32.
static int	toInt(java.util.BitSet bs) SNMP enumerates bits from left-to-right with 0-based index.
static java.lang.Object	toJava(org.snmp4j.smi.Variable var) Converts a SMI variable to the java.lang object.
static org.snmp4j.smi.Variable	toVariable(java.lang.Object obj, org.snmp4j.agent.mo.MOColumn<?> moColumn) Converts a java.lang object into a SMI object by calling the appropriate 'parseXXX' methods.
static org.snmp4j.smi.Variable	toVariable(java.lang.Object obj, org.snmp4j.agent.mo.MOScalar<?> moScalar) Converts a java.lang object into a SMI object by calling the appropriate 'parseXXX' methods.
static org.snmp4j.smi.Variable	toVariable(java.lang.Object obj, ValueSyntax syntax) Converts a java.lang object into a SMI object by calling the appropriate 'parseXXX' methods.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

defaultJavaValue

public static final java.lang.Object defaultJavaValue(int syntax)

Returns default values of different types, like 0 for numbers, empty string, 0.0.0.0 for IP address.

Parameters:

syntax - SMI syntax

Returns:

default value of specified SMI syntax

toJava

public static final java.lang.Object toJava(org.snmp4j.smi.Variable var)

Converts a SMI variable to the java.lang object.

Parameters:

var - a SMI variable

Returns:

a java.lang object

toVariable

public static final org.snmp4j.smi.Variable toVariable(java.lang.Object obj,
                                                       ValueSyntax syntax)
                                                throws FException

Converts a java.lang object into a SMI object by calling the appropriate 'parseXXX' methods.

Parameters:

obj - the java.lang object to convert.

syntax - the SMI syntax of this scalar to apply to the object.

Returns:

converted object.

Throws:

FException - if obj cannot be parsed.

toVariable

public static final org.snmp4j.smi.Variable toVariable(java.lang.Object obj,
                                                       org.snmp4j.agent.mo.MOScalar<?> moScalar)
                                                throws FException

Converts a java.lang object into a SMI object by calling the appropriate 'parseXXX' methods.

Parameters:

obj - the java.lang object to convert.

moScalar - the SMI syntax of this scalar to apply to the object.

Returns:

converted object.

Throws:

FException - if obj cannot be parsed.

toVariable

public static final org.snmp4j.smi.Variable toVariable(java.lang.Object obj,
                                                       org.snmp4j.agent.mo.MOColumn<?> moColumn)
                                                throws FException

Converts a java.lang object into a SMI object by calling the appropriate 'parseXXX' methods.

Parameters:

obj - the java.lang object to convert.

moColumn - the SMI syntax of this column to apply to the object.

Returns:

converted object.

Throws:

FException - if obj cannot be parsed.

parseBITS16

public static final org.snmp4j.smi.OctetString parseBITS16(int val)

Parses 16 bit integer to OctetString

Parameters:

val - 16 bit integer

Returns:

OctetString

parseBITS32

public static final org.snmp4j.smi.OctetString parseBITS32(int val)

Parses 32 bit integer to OctetString

Parameters:

val - 32 bit integer

Returns:

OctetString

parseBITS64

public static final org.snmp4j.smi.OctetString parseBITS64(long val)

Parses 64 bit integer to OctetString

Parameters:

val - 64 bit integer

Returns:

OctetString

parseInteger32

public static final org.snmp4j.smi.Integer32 parseInteger32(java.lang.Object obj)
                                                     throws FException

Parses Integer or String to Integer32.

Parameters:

obj - the object to convert.

Returns:

an instance of Integer32.

Throws:

FException - if obj cannot be parsed.

parseCounter64

public static final org.snmp4j.smi.Counter64 parseCounter64(java.lang.Object obj)
                                                     throws FException

Parses Long or String to Counter64.

Parameters:

obj - the object to convert.

Returns:

an instance of Counter64.

Throws:

FException - if obj cannot be parsed.

parseCounter32

public static final org.snmp4j.smi.Counter32 parseCounter32(java.lang.Object obj)
                                                     throws FException

Parses Long or String to Counter32.

Parameters:

obj - the object to convert.

Returns:

an instance of Counter32.

Throws:

FException - if obj cannot be parsed.

parseTimeTicks

public static final org.snmp4j.smi.TimeTicks parseTimeTicks(java.lang.Object obj)
                                                     throws FException

Parses Long or String to TimeTicks.

Parameters:

obj - the object to convert.

Returns:

an instance of TimeTicks.

Throws:

FException - if obj cannot be parsed.

parseUnsignedInteger32

public static final org.snmp4j.smi.UnsignedInteger32 parseUnsignedInteger32(java.lang.Object obj,
                                                                            int syntax)
                                                                     throws FException

Parses Long or String to UnsignedInteger32.

Parameters:

obj - the object to convert.

syntax - variable syntax as defined by SNMP4J (this value is native to scalar or table cell and is defined in MIB).

Returns:

an instance of UnsignedInteger32.

Throws:

FException - if obj cannot be parsed.

parseOID

public static final org.snmp4j.smi.OID parseOID(java.lang.Object obj)

Parses Number[], int[] or String to OID.

Parameters:

obj - the object to convert

Returns:

an instance of OID

parseIpAddress

public static final org.snmp4j.smi.IpAddress parseIpAddress(java.lang.Object obj)

Parses InetAddress or String to IpAddress.

Parameters:

obj - the object to convert

Returns:

an instance of IpAddress

toInt

public static final int toInt(java.util.BitSet bs)

SNMP enumerates bits from left-to-right with 0-based index. The bit 0 is a sign bit, and so on. Only first 32 bits from BitSet parameter are used to set bits for resulting int value.

Parameters:

bs - BitSet with first 32 bits considered

Returns:

int value with bits set