org.qbroker.net

Class SNMPConnector

java.lang.Object

org.qbroker.net.SNMPConnector

All Implemented Interfaces:

Connector

Direct Known Subclasses:

EventTrapSender, SNMPMessenger

public class SNMPConnector
extends java.lang.Object
implements Connector

SNMPConnector connects to an SNMP agent or manager and provides the following methods of for SNMP operations: snmpGet(), snmpSet(), sendTrap(), snmpNotify() and receive().

This is NOT MT-Safe. It requires Java 1.4 or above due to SNMP4J.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static char	ADDRESS
protected java.net.InetAddress	agentAddress
protected java.lang.String	agentName
static char	BITSTRING
protected java.lang.String	community
protected org.snmp4j.CommunityTarget	comTarget
static char	COUNTER32
static char	DECIMALSTRING
protected org.snmp4j.smi.OID	enterpriseOID
static char	HEXSTRING
protected java.lang.String	hostIP
protected java.lang.String	hostname
static char	INTEGER32
static char	NULL
static char	OIDSTRING
protected java.lang.String	operation
protected int	port
protected int	retry
protected org.snmp4j.Snmp	snmp
protected long	startTime
static char	STRING
protected int	timeout
static char	TIMETICKS
protected org.snmp4j.TransportMapping	transport
static char	UNSIGN32
protected java.lang.String	uri

Constructor Summary

Constructors

Constructor and Description
SNMPConnector(java.util.Map props) creates new SNMPConnector

Method Summary

Modifier and Type	Method and Description
void	close() closes all transports and resources
int	getDefaultVersion()
org.snmp4j.CommunityTarget	getTarget(int version, int retry, int timeout, java.lang.String community, java.lang.String address)
java.lang.String	getURI()
boolean	isConnected() returns true since it is connectionless
boolean	isListening()
static void	main(java.lang.String[] args)
java.lang.String[]	receive()
java.lang.String[]	receive(java.net.DatagramPacket p) receives an SNMP packet and returns the content in array of strings
java.lang.String	reconnect() reinitializes session
void	sendTrap(org.snmp4j.CommunityTarget target, java.lang.String ip, int generic, int specific, java.lang.String[][] data) sends out a trap for multiple oids
java.lang.String	snmpGet(org.snmp4j.CommunityTarget target, java.lang.String oid) returns a string of "oid = value" or an error message for failure
java.lang.String	snmpInquire(int version, java.lang.String community, java.lang.String address, java.lang.String oid) returns a string of "oid = value" for the community and the address
void	snmpNotify(org.snmp4j.CommunityTarget target, java.lang.String[][] data) sends a notification for multiple oids
void	snmpNotify(int version, java.lang.String community, java.lang.String address, java.lang.String[][] data) sends a notification of multiple oids to the address
java.lang.String	snmpSet(org.snmp4j.CommunityTarget target, java.lang.String[] data) It sets a value on oid and returns a string of null upon success or an error message for failure.
java.lang.String	snmpSet(int version, java.lang.String community, java.lang.String address, java.lang.String[] data) It sets a value on oid and returns a string of null upon success or an error message for failure.
java.lang.String	snmpSet(java.lang.String oid, int value)
void	snmpTrap(int version, java.lang.String community, java.lang.String address, java.lang.String ip, int generic, int specific, java.lang.String[][] data) sends out a trap of multiple oids to the address

Methods inherited from class java.lang.Object

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

Field Detail

hostname

protected java.lang.String hostname

hostIP

protected java.lang.String hostIP

agentAddress

protected java.net.InetAddress agentAddress

community

protected java.lang.String community

agentName

protected java.lang.String agentName

uri

protected java.lang.String uri

operation

protected java.lang.String operation

port

protected int port

timeout

protected int timeout

retry

protected int retry

startTime

protected long startTime

snmp

protected org.snmp4j.Snmp snmp

transport

protected org.snmp4j.TransportMapping transport

comTarget

protected org.snmp4j.CommunityTarget comTarget

enterpriseOID

protected org.snmp4j.smi.OID enterpriseOID

INTEGER32

public static final char INTEGER32

See Also:

Constant Field Values

UNSIGN32

public static final char UNSIGN32

See Also:

Constant Field Values

COUNTER32

public static final char COUNTER32

See Also:

Constant Field Values

STRING

public static final char STRING

See Also:

Constant Field Values

HEXSTRING

public static final char HEXSTRING

See Also:

Constant Field Values

DECIMALSTRING

public static final char DECIMALSTRING

See Also:

Constant Field Values

NULL

public static final char NULL

See Also:

Constant Field Values

TIMETICKS

public static final char TIMETICKS

See Also:

Constant Field Values

ADDRESS

public static final char ADDRESS

See Also:

Constant Field Values

BITSTRING

public static final char BITSTRING

See Also:

Constant Field Values

OIDSTRING

public static final char OIDSTRING

See Also:

Constant Field Values

Constructor Detail

SNMPConnector

public SNMPConnector(java.util.Map props)

creates new SNMPConnector

Method Detail

getTarget

public org.snmp4j.CommunityTarget getTarget(int version,
                                            int retry,
                                            int timeout,
                                            java.lang.String community,
                                            java.lang.String address)

snmpInquire

public java.lang.String snmpInquire(int version,
                                    java.lang.String community,
                                    java.lang.String address,
                                    java.lang.String oid)
                             throws java.io.IOException

returns a string of "oid = value" for the community and the address

Throws:

java.io.IOException

snmpGet

public java.lang.String snmpGet(org.snmp4j.CommunityTarget target,
                                java.lang.String oid)
                         throws java.io.IOException

returns a string of "oid = value" or an error message for failure

Throws:

java.io.IOException

snmpSet

public java.lang.String snmpSet(java.lang.String oid,
                                int value)
                         throws java.io.IOException

Throws:

java.io.IOException

snmpSet

public java.lang.String snmpSet(int version,
                                java.lang.String community,
                                java.lang.String address,
                                java.lang.String[] data)
                         throws java.io.IOException

It sets a value on oid and returns a string of null upon success or an error message for failure.

Throws:

java.io.IOException

snmpSet

public java.lang.String snmpSet(org.snmp4j.CommunityTarget target,
                                java.lang.String[] data)
                         throws java.io.IOException

It sets a value on oid and returns a string of null upon success or an error message for failure.

Throws:

java.io.IOException

snmpTrap

public void snmpTrap(int version,
                     java.lang.String community,
                     java.lang.String address,
                     java.lang.String ip,
                     int generic,
                     int specific,
                     java.lang.String[][] data)
              throws java.io.IOException

sends out a trap of multiple oids to the address

Throws:

java.io.IOException

sendTrap

public void sendTrap(org.snmp4j.CommunityTarget target,
                     java.lang.String ip,
                     int generic,
                     int specific,
                     java.lang.String[][] data)
              throws java.io.IOException

sends out a trap for multiple oids

Throws:

java.io.IOException

snmpNotify

public void snmpNotify(int version,
                       java.lang.String community,
                       java.lang.String address,
                       java.lang.String[][] data)
                throws java.io.IOException

sends a notification of multiple oids to the address

Throws:

java.io.IOException

snmpNotify

public void snmpNotify(org.snmp4j.CommunityTarget target,
                       java.lang.String[][] data)
                throws java.io.IOException

sends a notification for multiple oids

Throws:

java.io.IOException

receive

public java.lang.String[] receive()
                           throws java.io.IOException

Throws:

java.io.IOException

receive

public java.lang.String[] receive(java.net.DatagramPacket p)
                           throws java.io.IOException

receives an SNMP packet and returns the content in array of strings

Throws:

java.io.IOException

getDefaultVersion

public int getDefaultVersion()

isListening

public boolean isListening()

getURI

public java.lang.String getURI()

Specified by:

getURI in interface Connector

isConnected

public boolean isConnected()

returns true since it is connectionless

Specified by:

isConnected in interface Connector

reconnect

public java.lang.String reconnect()

reinitializes session

Specified by:

reconnect in interface Connector

close

public void close()

closes all transports and resources

Specified by:

close in interface Connector

main

public static void main(java.lang.String[] args)