org.qbroker.jms

Class SNMPMessenger

java.lang.Object

org.qbroker.net.SNMPConnector

org.qbroker.jms.SNMPMessenger

All Implemented Interfaces:

Connector

public class SNMPMessenger
extends SNMPConnector

SNMPMessenger handles JMS Messages IO on SNMP resources. The SNMP env has to be established before using this object. Due to SNMP4J, it requires Java 1.4 or above.

There are four methods, listen(), talk(), inquire() and reply() on packets. The method of listen() is NOT MT-Safe. The method of talk() is for asynchronous output whereas inquire() is for synchronous requests.

For charSet and encoding, you can overwrite the default encoding by starting JVM with "-Dfile.encoding=UTF8 your_class".

Author:

yannanlu@yahoo.com

Field Summary

Fields inherited from class org.qbroker.net.SNMPConnector

ADDRESS, agentAddress, agentName, BITSTRING, community, comTarget, COUNTER32, DECIMALSTRING, enterpriseOID, HEXSTRING, hostIP, hostname, INTEGER32, NULL, OIDSTRING, port, retry, snmp, startTime, STRING, timeout, TIMETICKS, transport, UNSIGN32, uri

Constructor Summary

Constructors

Constructor and Description
SNMPMessenger(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOperation()
void	inquire(XQueue xq) It continually gets a JMS Message with an SNMP request from the XQueue.
void	listen(XQueue xq) It listens to the DatagramSocket for incoming SNMP packets.
void	send(XQueue xq) It continually gets a JMS Message from the XQueue, sends its content and its OID to an SNMP manager.

Methods inherited from class org.qbroker.net.SNMPConnector

close, getDefaultVersion, getTarget, getURI, isConnected, isListening, main, receive, receive, reconnect, sendTrap, snmpGet, snmpInquire, snmpNotify, snmpNotify, snmpSet, snmpSet, snmpSet, snmpTrap

Methods inherited from class java.lang.Object

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

Constructor Detail

SNMPMessenger

public SNMPMessenger(java.util.Map props)

Method Detail

listen

public void listen(XQueue xq)
            throws java.io.IOException,
                   javax.jms.JMSException

It listens to the DatagramSocket for incoming SNMP packets. Once receiving an SNMP packet, it loads the payload of the packet to a JMSMessage and puts it to the XQueue as output.

Most of the IOExceptions from the stream IO operations, like receive, will be thrown to notify the caller. The caller is supposed to catch the exception, either to reset the socket or to do other stuff. It also throws JMSException from the operations regarding to the message itself, like get/set JMS properties. This does not require to reset the socket at all.

This method is NOT MT-Safe.

Throws:

java.io.IOException

javax.jms.JMSException

inquire

public void inquire(XQueue xq)
             throws java.io.IOException,
                    javax.jms.JMSException

It continually gets a JMS Message with an SNMP request from the XQueue. Then it sends the request to the destination and waits for the response. Once response is back, it puts the content back to the message and removes the message from the XQueue.

Most of the IOExceptions from the packet IO operations, like send, will be thrown to notify the caller. The caller is supposed to catch the exception, either to reset the socket or to do other stuff. It also throws JMSException from the operations regarding to the message itself, like get/set JMS properties. This does not require to reset the socket at all.

Since the inquire operation relies on a request, this method will intercept the request and process it. The incoming message is required to be writeable. The method will set a String property of the message specified by the RCField with the return code, indicating the status of the process to fulfill the request. The requester is required to check the value of the property once it gets the message back. If the return code is 0, the inquirey is successful. This method will not acknowledge messages. It is up to the requester to do that.

This method is NOT MT-Safe.

Throws:

java.io.IOException

javax.jms.JMSException

send

public void send(XQueue xq)
          throws java.io.IOException,
                 javax.jms.JMSException

It continually gets a JMS Message from the XQueue, sends its content and its OID to an SNMP manager.

Most of the IOExceptions from the packet IO operations, like send, will be thrown to notify the caller. The caller is supposed to catch the exception, either to reset the socket or to do other stuff. It also throws JMSException from the operations regarding to the message itself, like get/set JMS properties. This does not require to reset the socket at all.

It will not modify the original messages. If the XQueue has enabled the EXTERNAL_XA, it will also acknowledge every messages. This method is MT-Safe.

Throws:

java.io.IOException

javax.jms.JMSException

getOperation

public java.lang.String getOperation()