RequestHandlerSupport (Various API) - JBoss 4.0.1 sp1 varia API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: RequestHandler, org.opennms.protocols.snmp.SnmpAgentHandler

public class RequestHandlerSupport
extends Object
implements RequestHandler

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

Version:: $Revision: 1.1.4.1 $
Author:: Krishnaraj S, Dimitris Andreadis

Field Summary

protected Clock clock
          the agent clock

protected org.jboss.logging.Logger log
          Logger object

protected String resourceName
          the file name to get mapping info from

protected javax.management.MBeanServer server
          the MBeanServer

Constructor Summary

RequestHandlerSupport()
          Default CTOR

Method Summary

void initialize(String resourceName, javax.management.MBeanServer server, org.jboss.logging.Logger log, Clock uptime)
          Initialize

void SnmpAgentSessionError(org.opennms.protocols.snmp.SnmpAgentSession session, int error, Object ref)
          This method is invoked if an error occurs in the session.

org.opennms.protocols.snmp.SnmpPduRequest snmpReceivedGet(org.opennms.protocols.snmp.SnmpPduPacket pdu, boolean getNext)
          This method is defined to handle SNMP Get requests that are received by the session.

void snmpReceivedPdu(org.opennms.protocols.snmp.SnmpAgentSession session, InetAddress manager, int port, org.opennms.protocols.snmp.SnmpOctetString community, org.opennms.protocols.snmp.SnmpPduPacket pdu)
          This method is defined to handle SNMP requests that are received by the session.

org.opennms.protocols.snmp.SnmpPduRequest snmpReceivedSet(org.opennms.protocols.snmp.SnmpPduPacket pdu)
          This method is defined to handle SNMP Set requests that are received by the session.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.jboss.logging.Logger log

Logger object

server

protected javax.management.MBeanServer server

the MBeanServer

resourceName

protected String resourceName

the file name to get mapping info from

clock

protected Clock clock

the agent clock

Constructor Detail

RequestHandlerSupport

public RequestHandlerSupport()

Default CTOR

Method Detail

initialize

public void initialize(String resourceName,
                       javax.management.MBeanServer server,
                       org.jboss.logging.Logger log,
                       Clock uptime)
                throws Exception

Initialize

Specified by:: initialize in interface RequestHandler

Parameters:: resourceName - file containing mappinginfo; server - the mbean server to forward mapped get/set requests; uptime - the snmp agent uptime
Throws:: Exception - in case of initialization problem

snmpReceivedGet

public org.opennms.protocols.snmp.SnmpPduRequest snmpReceivedGet(org.opennms.protocols.snmp.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.

Specified by:: snmpReceivedGet in interface org.opennms.protocols.snmp.SnmpAgentHandler

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 org.opennms.protocols.snmp.SnmpPduRequest snmpReceivedSet(org.opennms.protocols.snmp.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.

Specified by:: snmpReceivedSet in interface org.opennms.protocols.snmp.SnmpAgentHandler

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(org.opennms.protocols.snmp.SnmpAgentSession session,
                            InetAddress manager,
                            int port,
                            org.opennms.protocols.snmp.SnmpOctetString community,
                            org.opennms.protocols.snmp.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

Specified by:: snmpReceivedPdu in interface org.opennms.protocols.snmp.SnmpAgentHandler

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(org.opennms.protocols.snmp.SnmpAgentSession session,
                                  int error,
                                  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.

Specified by:: SnmpAgentSessionError in interface org.opennms.protocols.snmp.SnmpAgentHandler

Parameters:: session - The SNMP Session; error - The error condition value.; ref - The PDU reference, or potentially null. It may also be an exception.