org.jboss.jmx.adaptor.snmp.agent
Class RequestHandlerSupport

java.lang.Object
  org.jboss.jmx.adaptor.snmp.agent.RequestHandlerSupport

All Implemented Interfaces:

RequestHandler (src)

public class RequestHandlerSupport

extends java.lang.Object

implements RequestHandler (src)

Implement RequestHandler with simple tracing of incoming requests. Derived classes are expected to implement actual behaviour.

log

protected Logger (src)  log

Logger object

server

protected MBeanServer (src)  server

the MBeanServer

resourceName

protected java.lang.String resourceName

the file name to get mapping info from

clock

protected Clock (src)  clock

the agent clock

RequestHandlerSupport

public RequestHandlerSupport()

Default CTOR

initialize

public void initialize(java.lang.String resourceName,
                       MBeanServer (src)  server,
                       Logger (src)  log,
                       Clock (src)  uptime)
                throws java.lang.Exception

Initialize

Specified by:

initialize in interface RequestHandler (src)

Parameters:

resourceName - file containing mappinginfo

server - the mbean server to forward mapped get/set requests

uptime - the snmp agent uptime

Throws:

java.lang.Exception - in case of initialization problem

snmpReceivedGet

public SnmpPduRequest snmpReceivedGet(SnmpPduPacket pdu,
                                      boolean getNext)

This method is defined to handle SNMP Get requests that are received by the session. The request has already been validated by the system. This routine will build a response and pass it back to the caller.

Parameters:

pdu - The SNMP pdu

getNext - The agent is requesting the lexically NEXT item after each item in the pdu.

Returns:

SnmpPduRequest filled in with the proper response, or null if cannot process NOTE: this might be changed to throw an exception.

snmpReceivedSet

public SnmpPduRequest snmpReceivedSet(SnmpPduPacket pdu)

This method is defined to handle SNMP Set requests that are received by the session. The request has already been validated by the system. This routine will build a response and pass it back to the caller.

Parameters:

pdu - The SNMP pdu

Returns:

SnmpPduRequest filled in with the proper response, or null if cannot process NOTE: this might be changed to throw an exception.

snmpReceivedPdu

public void snmpReceivedPdu(SnmpAgentSession session,
                            java.net.InetAddress manager,
                            int port,
                            SnmpOctetString community,
                            SnmpPduPacket pdu)

This method is defined to handle SNMP requests that are received by the session. The parameters allow the handler to determine the host, port, and community string of the received PDU

Parameters:

session - The SNMP session

manager - The remote sender

port - The remote senders port

community - The community string

pdu - The SNMP pdu

SnmpAgentSessionError

public void SnmpAgentSessionError(SnmpAgentSession session,
                                  int error,
                                  java.lang.Object ref)

This method is invoked if an error occurs in the session. The error code that represents the failure will be passed in the second parameter, 'error'. The error codes can be found in the class SnmpAgentSession class.

If a particular PDU is part of the error condition it will be passed in the third parameter, 'pdu'. The pdu will be of the type SnmpPduRequest or SnmpPduTrap object. The handler should use the "instanceof" operator to determine which type the object is. Also, the object may be null if the error condition is not associated with a particular PDU.

Parameters:

session - The SNMP Session

error - The error condition value.

ref - The PDU reference, or potentially null. It may also be an exception.