Save This Page
Home » JBoss-5.1.0 » org.jboss.jmx.adaptor.snmp » agent » [javadoc | source]
org.jboss.jmx.adaptor.snmp.agent
public class: SnmpAgentService [javadoc | source]
java.lang.Object
   org.jboss.mx.util.JBossNotificationBroadcasterSupport
      org.jboss.system.ServiceMBeanSupport
         org.jboss.system.ListenerServiceMBeanSupport
            org.jboss.jmx.adaptor.snmp.agent.SnmpAgentService

All Implemented Interfaces:
    SnmpAgentServiceMBean, NotificationListener, ListenerServiceMBean, KernelControllerContextAware, ServiceMBean, MBeanRegistration, NotificationEmitter

SnmpAgentService is an MBean class implementing an SNMP agent. It allows to send V1 or V2 traps to one or more SNMP managers defined by their IP address, listening port number and expected SNMP version. It support mapping SNMP get/set requests JMX mbean attribute get/sets.
Field Summary
public static final  int SNMPV1    Supported versions 
public static final  int SNMPV2     
public static final  String DEFAULT_READ_COMMUNITY    Default communities 
public static final  String DEFAULT_WRITE_COMMUNITY     
Fields inherited from org.jboss.system.ServiceMBeanSupport:
SERVICE_CONTROLLER_SIG,  log,  server,  serviceName
Constructor:
 public SnmpAgentService() 
Method from org.jboss.jmx.adaptor.snmp.agent.SnmpAgentService Summary:
getBindAddress,   getDynamicSubscriptions,   getHeartBeatPeriod,   getInstantiationTime,   getManagersResName,   getNotificationMapResName,   getNumberOfThreads,   getPort,   getRequestHandlerClassName,   getRequestHandlerResName,   getSnmpVersion,   getTimerName,   getTrapCount,   getTrapFactoryClassName,   getUptime,   handleNotification2,   reconfigureRequestHandler,   setBindAddress,   setDynamicSubscriptions,   setHeartBeatPeriod,   setManagersResName,   setNotificationMapResName,   setNumberOfThreads,   setPort,   setReadCommunity,   setRequestHandlerClassName,   setRequestHandlerResName,   setSnmpVersion,   setTimerName,   setTrapFactoryClassName,   setWriteCommunity,   startService,   stopService
Methods from org.jboss.system.ListenerServiceMBeanSupport:
getSubscriptions,   handleNotification,   handleNotification2,   setSubscriptionList,   setSubscriptions,   subscribe,   subscribe,   subscribe,   unsubscribe
Methods from org.jboss.system.ServiceMBeanSupport:
create,   createService,   destroy,   destroyService,   getDeploymentInfo,   getLog,   getName,   getNextNotificationSequenceNumber,   getObjectName,   getServer,   getServiceName,   getState,   getStateString,   jbossInternalCreate,   jbossInternalDescription,   jbossInternalDestroy,   jbossInternalLifecycle,   jbossInternalStart,   jbossInternalStop,   pojoChange,   pojoCreate,   pojoDestroy,   pojoStart,   pojoStop,   postDeregister,   postRegister,   preDeregister,   preRegister,   setKernelControllerContext,   start,   startService,   stop,   stopService,   unsetKernelControllerContext
Methods from org.jboss.mx.util.JBossNotificationBroadcasterSupport:
addNotificationListener,   getNotificationInfo,   handleNotification,   nextNotificationSequenceNumber,   removeNotificationListener,   removeNotificationListener,   sendNotification
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jboss.jmx.adaptor.snmp.agent.SnmpAgentService Detail:
 public String getBindAddress() 
    Gets the agent bind address
 public boolean getDynamicSubscriptions() 
    Gets the dynamic subscriptions status
 public int getHeartBeatPeriod() 
    Gets the heartbeat switch
 public long getInstantiationTime() 
    Returns the difference, measured in milliseconds, between the instantiation time and midnight, January 1, 1970 UTC.
 public String getManagersResName() 
    Gets the name of the file containing SNMP manager specifications
 public String getNotificationMapResName() 
    Gets the name of the file containing the notification/trap mappings
 public int getNumberOfThreads() 
    Gets the number of threads in the agent requests processing thread pool
 public int getPort() 
    Gets the agent listening port number
 public String getRequestHandlerClassName() 
    Gets the RequestHandler implementation class
 public String getRequestHandlerResName() 
    Gets the resource file name containing get/set mappings
 public int getSnmpVersion() 
    Gets the snmp protocol version
 public ObjectName getTimerName() 
    Gets the utilised timer MBean name
 public long getTrapCount() 
    Returns the current trap counter reading
 public String getTrapFactoryClassName() 
    Gets the utilised trap factory name
 public long getUptime() 
    Returns the up-time
 public  void handleNotification2(Notification n,
    Object handback) 
    All notifications are intercepted here and are routed for emission.
 public  void reconfigureRequestHandler() throws Exception 
    Reconfigures the RequestHandler, reponsible for handling get requests etc.
 public  void setBindAddress(String bindAddress) throws UnknownHostException 
    Sets the agent bind address
 public  void setDynamicSubscriptions(boolean dynamicSubscriptions) 
    Enables/disables dynamic subscriptions
 public  void setHeartBeatPeriod(int heartBeatPeriod) 
    Sets the heartbeat period (in seconds) switch
 public  void setManagersResName(String managersResName) 
    Sets the name of the file containing SNMP manager specifications
 public  void setNotificationMapResName(String notificationMapResName) 
    Sets the name of the file containing the notification/trap mappings
 public  void setNumberOfThreads(int numberOfThreads) 
    Sets the number of threads in the agent request processing thread pool
 public  void setPort(int port) 
    Sets the agent listening port number
 public  void setReadCommunity(String readCommunity) 
    Sets the read community (no getter)
 public  void setRequestHandlerClassName(String requestHandlerClassName) 
    Sets the RequestHandler implementation class
 public  void setRequestHandlerResName(String requestHandlerResName) 
    Sets the resource file name containing get/set mappings
 public  void setSnmpVersion(int snmpVersion) 
    Sets the snmp protocol version
 public  void setTimerName(ObjectName timerName) 
    Sets the utilised timer MBean name
 public  void setTrapFactoryClassName(String name) 
    Sets the utilised trap factory name
 public  void setWriteCommunity(String writeCommunity) 
    Sets the write community (no getter)
 protected  void startService() throws Exception 
    Perform service start-up
 protected  void stopService() throws Exception 
    Perform service shutdown