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

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:

java.util.EventListener, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, javax.management.NotificationEmitter, javax.management.NotificationListener, SnmpAgentServiceMBean, org.jboss.kernel.spi.dependency.KernelControllerContextAware, org.jboss.system.ListenerServiceMBean, org.jboss.system.Service, org.jboss.system.ServiceMBean

public class SnmpAgentService
extends org.jboss.system.ListenerServiceMBeanSupport
implements SnmpAgentServiceMBean

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.

Version:

$Revision: 110838 $

Author:

Spyros Pollatos, Dimitris Andreadis, Krishnaraj S

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.system.ListenerServiceMBeanSupport

org.jboss.system.ListenerServiceMBeanSupport.SubscriptionInfo

Field Summary

static java.lang.String	DEFAULT_READ_COMMUNITY Default communities
static java.lang.String	DEFAULT_WRITE_COMMUNITY
static int	SNMPV1 Supported versions
static int	SNMPV2
static int	SNMPV3

Fields inherited from class org.jboss.system.ServiceMBeanSupport

log, server, SERVICE_CONTROLLER_SIG, serviceName

Fields inherited from interface org.jboss.jmx.adaptor.snmp.agent.SnmpAgentServiceMBean

OBJECT_NAME

Fields inherited from interface org.jboss.system.ListenerServiceMBean

SL_FILTER_ELEMENT, SL_FILTER_FACTORY_ATTRIBUTE, SL_MBEAN_ELEMENT, SL_MBEAN_HANDBACK_ATTRIBUTE, SL_MBEAN_NAME_ATTRIBUTE, SL_NOTIFICATION_ELEMENT, SL_NOTIFICATION_TYPE_ATTRIBUTE, SL_ROOT_ELEMENT

Fields inherited from interface org.jboss.system.ServiceMBean

CREATE_EVENT, CREATED, DESTROY_EVENT, DESTROYED, FAILED, REGISTERED, START_EVENT, STARTED, STARTING, states, STOP_EVENT, STOPPED, STOPPING, UNREGISTERED

Constructor Summary

SnmpAgentService()
Default CTOR

Method Summary

void	addAttributeMappings(java.util.List<ManagedBean> mappings)
void	addNotifications(java.util.List<Mapping> notifications)
java.lang.String	getBindAddress() Gets the agent bind address
Clock	getClock()
boolean	getDynamicSubscriptions() Gets the dynamic subscriptions status
int	getHeartBeatPeriod() Gets the heartbeat switch
long	getInstantiationTime() Returns the difference, measured in milliseconds, between the instantiation time and midnight, January 1, 1970 UTC.
java.lang.String	getManagersResName() Gets the name of the file containing SNMP manager specifications
long	getNextJMXNotificationSequenceNumber()
java.lang.String	getNotificationMapResName() Gets the name of the file containing the notification/trap mappings
int	getNumberOfThreads() Gets the number of threads in the agent requests processing thread pool
int	getPort() Gets the agent listening port number
RequestHandler	getRequestHandler()
java.lang.String	getRequestHandlerClassName() Gets the RequestHandler implementation class
java.lang.String	getRequestHandlerResName() Gets the resource file name containing get/set mappings
SnmpRequest	getResponder()
org.snmp4j.Snmp	getSession()
int	getSnmpVersion() Gets the snmp protocol version
javax.management.ObjectName	getTimerName() Gets the utilised timer MBean name
org.snmp4j.TransportMapping[]	getTransportMappings()
long	getTrapCount() Returns the current trap counter reading
Counter	getTrapCounter()
java.lang.String	getTrapFactoryClassName() Gets the utilised trap factory name
long	getUptime() Returns the up-time
java.util.Map<java.lang.String,User>	getUserMap()
java.lang.String	getUsersResName()
void	handleNotification2(javax.management.Notification n, java.lang.Object handback) All notifications are intercepted here and are routed for emission.
void	reconfigureRequestHandler() Reconfigures the RequestHandler, reponsible for handling get requests etc.
void	removeAttributeMappings(java.util.List<ManagedBean> mappings)
void	removeNotifications(java.util.List<Mapping> notifications)
void	sendJMXNotification(javax.management.Notification notification)
void	setBindAddress(java.lang.String bindAddress) Sets the agent bind address
void	setDynamicSubscriptions(boolean dynamicSubscriptions) Enables/disables dynamic subscriptions
void	setHeartBeatPeriod(int heartBeatPeriod) Sets the heartbeat period (in seconds) switch
void	setManagersResName(java.lang.String managersResName) Sets the name of the file containing SNMP manager specifications
void	setNotificationMapResName(java.lang.String notificationMapResName) Sets the name of the file containing the notification/trap mappings
void	setNumberOfThreads(int numberOfThreads) Sets the number of threads in the agent request processing thread pool
void	setPort(int port) Sets the agent listening port number
void	setReadCommunity(java.lang.String readCommunity) Sets the read community (no getter)
void	setRequestHandlerClassName(java.lang.String requestHandlerClassName) Sets the RequestHandler implementation class
void	setRequestHandlerResName(java.lang.String requestHandlerResName) Sets the resource file name containing get/set mappings
void	setSnmpVersion(int snmpVersion) Sets the snmp protocol version
void	setTimerName(javax.management.ObjectName timerName) Sets the utilised timer MBean name
void	setTrapFactoryClassName(java.lang.String name) Sets the utilised trap factory name
void	setUsersResName(java.lang.String usersResName) The name of the file containing SNMPv3 users
void	setWriteCommunity(java.lang.String writeCommunity) Sets the write community (no getter)
protected void	startService() Perform service start-up
protected void	stopService() Perform service shutdown

Methods inherited from class org.jboss.system.ListenerServiceMBeanSupport

getSubscriptions, handleNotification, setSubscriptionList, setSubscriptions, subscribe, subscribe, subscribe, unsubscribe

Methods inherited from class 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, stop, unsetKernelControllerContext

Methods inherited from class org.jboss.mx.util.JBossNotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, handleNotification, nextNotificationSequenceNumber, removeNotificationListener, removeNotificationListener, sendNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.system.ListenerServiceMBean

setSubscriptionList

Methods inherited from interface org.jboss.system.ServiceMBean

getName, getState, getStateString, jbossInternalLifecycle

Methods inherited from interface org.jboss.system.Service

create, destroy, start, stop

Field Detail

SNMPV1

public static final int SNMPV1

Supported versions

See Also:

Constant Field Values

SNMPV2

public static final int SNMPV2

See Also:

Constant Field Values

SNMPV3

public static final int SNMPV3

See Also:

Constant Field Values

DEFAULT_READ_COMMUNITY

public static final java.lang.String DEFAULT_READ_COMMUNITY

Default communities

See Also:

Constant Field Values

DEFAULT_WRITE_COMMUNITY

public static final java.lang.String DEFAULT_WRITE_COMMUNITY

See Also:

Constant Field Values

Constructor Detail

SnmpAgentService

public SnmpAgentService()

Default CTOR

Method Detail

getHeartBeatPeriod

public int getHeartBeatPeriod()

Gets the heartbeat switch

Specified by:

getHeartBeatPeriod in interface SnmpAgentServiceMBean

setHeartBeatPeriod

public void setHeartBeatPeriod(int heartBeatPeriod)

Sets the heartbeat period (in seconds) switch

Specified by:

setHeartBeatPeriod in interface SnmpAgentServiceMBean

getInstantiationTime

public long getInstantiationTime()

Returns the difference, measured in milliseconds, between the instantiation time and midnight, January 1, 1970 UTC.

Specified by:

getInstantiationTime in interface SnmpAgentServiceMBean

getUptime

public long getUptime()

Returns the up-time

Specified by:

getUptime in interface SnmpAgentServiceMBean

getTrapCount

public long getTrapCount()

Returns the current trap counter reading

Specified by:

getTrapCount in interface SnmpAgentServiceMBean

setManagersResName

public void setManagersResName(java.lang.String managersResName)

Sets the name of the file containing SNMP manager specifications

Specified by:

setManagersResName in interface SnmpAgentServiceMBean

getManagersResName

public java.lang.String getManagersResName()

Gets the name of the file containing SNMP manager specifications

Specified by:

getManagersResName in interface SnmpAgentServiceMBean

setNotificationMapResName

public void setNotificationMapResName(java.lang.String notificationMapResName)

Sets the name of the file containing the notification/trap mappings

Specified by:

setNotificationMapResName in interface SnmpAgentServiceMBean

getNotificationMapResName

public java.lang.String getNotificationMapResName()

Gets the name of the file containing the notification/trap mappings

Specified by:

getNotificationMapResName in interface SnmpAgentServiceMBean

setTrapFactoryClassName

public void setTrapFactoryClassName(java.lang.String name)

Sets the utilised trap factory name

Specified by:

setTrapFactoryClassName in interface SnmpAgentServiceMBean

getTrapFactoryClassName

public java.lang.String getTrapFactoryClassName()

Gets the utilised trap factory name

Specified by:

getTrapFactoryClassName in interface SnmpAgentServiceMBean

setTimerName

public void setTimerName(javax.management.ObjectName timerName)

Sets the utilised timer MBean name

Specified by:

setTimerName in interface SnmpAgentServiceMBean

getTimerName

public javax.management.ObjectName getTimerName()

Gets the utilised timer MBean name

Specified by:

getTimerName in interface SnmpAgentServiceMBean

setBindAddress

public void setBindAddress(java.lang.String bindAddress)
                    throws java.net.UnknownHostException

Sets the agent bind address

Specified by:

setBindAddress in interface SnmpAgentServiceMBean

Throws:

java.net.UnknownHostException

getBindAddress

public java.lang.String getBindAddress()

Gets the agent bind address

Specified by:

getBindAddress in interface SnmpAgentServiceMBean

setNumberOfThreads

public void setNumberOfThreads(int numberOfThreads)

Sets the number of threads in the agent request processing thread pool

Specified by:

setNumberOfThreads in interface SnmpAgentServiceMBean

getNumberOfThreads

public int getNumberOfThreads()

Gets the number of threads in the agent requests processing thread pool

Specified by:

getNumberOfThreads in interface SnmpAgentServiceMBean

setPort

public void setPort(int port)

Sets the agent listening port number

Specified by:

setPort in interface SnmpAgentServiceMBean

getPort

public int getPort()

Gets the agent listening port number

Specified by:

getPort in interface SnmpAgentServiceMBean

setSnmpVersion

public void setSnmpVersion(int snmpVersion)

Sets the snmp protocol version

Specified by:

setSnmpVersion in interface SnmpAgentServiceMBean

getSnmpVersion

public int getSnmpVersion()

Gets the snmp protocol version

Specified by:

getSnmpVersion in interface SnmpAgentServiceMBean

setReadCommunity

public void setReadCommunity(java.lang.String readCommunity)

Sets the read community (no getter)

Specified by:

setReadCommunity in interface SnmpAgentServiceMBean

setWriteCommunity

public void setWriteCommunity(java.lang.String writeCommunity)

Sets the write community (no getter)

Specified by:

setWriteCommunity in interface SnmpAgentServiceMBean

setRequestHandlerClassName

public void setRequestHandlerClassName(java.lang.String requestHandlerClassName)

Sets the RequestHandler implementation class

Specified by:

setRequestHandlerClassName in interface SnmpAgentServiceMBean

getRequestHandlerClassName

public java.lang.String getRequestHandlerClassName()

Gets the RequestHandler implementation class

Specified by:

getRequestHandlerClassName in interface SnmpAgentServiceMBean

setRequestHandlerResName

public void setRequestHandlerResName(java.lang.String requestHandlerResName)

Sets the resource file name containing get/set mappings

Specified by:

setRequestHandlerResName in interface SnmpAgentServiceMBean

getRequestHandlerResName

public java.lang.String getRequestHandlerResName()

Gets the resource file name containing get/set mappings

Specified by:

getRequestHandlerResName in interface SnmpAgentServiceMBean

setDynamicSubscriptions

public void setDynamicSubscriptions(boolean dynamicSubscriptions)

Enables/disables dynamic subscriptions

Specified by:

setDynamicSubscriptions in interface SnmpAgentServiceMBean

getDynamicSubscriptions

public boolean getDynamicSubscriptions()

Gets the dynamic subscriptions status

Specified by:

getDynamicSubscriptions in interface SnmpAgentServiceMBean

reconfigureRequestHandler

public void reconfigureRequestHandler()
                               throws java.lang.Exception

Reconfigures the RequestHandler, reponsible for handling get requests etc.

Specified by:

reconfigureRequestHandler in interface SnmpAgentServiceMBean

Throws:

java.lang.Exception

startService

protected void startService()
                     throws java.lang.Exception

Perform service start-up

Overrides:

startService in class org.jboss.system.ServiceMBeanSupport

Throws:

java.lang.Exception

stopService

protected void stopService()
                    throws java.lang.Exception

Perform service shutdown

Overrides:

stopService in class org.jboss.system.ServiceMBeanSupport

Throws:

java.lang.Exception

handleNotification2

public void handleNotification2(javax.management.Notification n,
                                java.lang.Object handback)

All notifications are intercepted here and are routed for emission.

Overrides:

handleNotification2 in class org.jboss.system.ListenerServiceMBeanSupport

setUsersResName

public void setUsersResName(java.lang.String usersResName)

Description copied from interface: SnmpAgentServiceMBean

The name of the file containing SNMPv3 users

Specified by:

setUsersResName in interface SnmpAgentServiceMBean

Parameters:

usersResName - the usersResName to set

getUsersResName

public java.lang.String getUsersResName()

Specified by:

getUsersResName in interface SnmpAgentServiceMBean

Returns:

the usersResName

getClock

public Clock getClock()

Returns:

the clock

getTrapCounter

public Counter getTrapCounter()

Returns:

the trapCounter

getUserMap

public java.util.Map<java.lang.String,User> getUserMap()

Returns:

the userList

getSession

public org.snmp4j.Snmp getSession()

Returns:

the session

getResponder

public SnmpRequest getResponder()

Returns:

the responder

getRequestHandler

public RequestHandler getRequestHandler()

Returns:

the requestHandler

getTransportMappings

public org.snmp4j.TransportMapping[] getTransportMappings()

Returns:

the transportMappings

sendJMXNotification

public void sendJMXNotification(javax.management.Notification notification)

Specified by:

sendJMXNotification in interface SnmpAgentServiceMBean

getNextJMXNotificationSequenceNumber

public long getNextJMXNotificationSequenceNumber()

Specified by:

getNextJMXNotificationSequenceNumber in interface SnmpAgentServiceMBean

addAttributeMappings

public void addAttributeMappings(java.util.List<ManagedBean> mappings)

Specified by:

addAttributeMappings in interface SnmpAgentServiceMBean

removeAttributeMappings

public void removeAttributeMappings(java.util.List<ManagedBean> mappings)

Specified by:

removeAttributeMappings in interface SnmpAgentServiceMBean

addNotifications

public void addNotifications(java.util.List<Mapping> notifications)

Specified by:

addNotifications in interface SnmpAgentServiceMBean

removeNotifications

public void removeNotifications(java.util.List<Mapping> notifications)

Specified by:

removeNotifications in interface SnmpAgentServiceMBean