org.jboss.jmx.adaptor.snmp.agent
Interface SnmpAgentServiceMBean

All Superinterfaces:

org.jboss.system.ListenerServiceMBean, org.jboss.system.Service, org.jboss.system.ServiceMBean

All Known Implementing Classes:

SnmpAgentService

public interface SnmpAgentServiceMBean
extends org.jboss.system.ListenerServiceMBean

SnmpAgentService MBean interface.

Version:

$Revision: 81038 $

Author:

Dimitris Andreadis

Field Summary

static javax.management.ObjectName

OBJECT_NAME Default ObjectName

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

Method Summary

void	addAttributeMappings(java.util.List<ManagedBean> mappings)
void	addNotifications(java.util.List<Mapping> notifications)
java.lang.String	getBindAddress()
boolean	getDynamicSubscriptions()
int	getHeartBeatPeriod()
long	getInstantiationTime() The time difference (in msecs) between instantiation time and epoch (midnight, January 1, 1970 UTC)
java.lang.String	getManagersResName()
long	getNextJMXNotificationSequenceNumber()
java.lang.String	getNotificationMapResName()
int	getNumberOfThreads()
int	getPort()
java.lang.String	getRequestHandlerClassName()
java.lang.String	getRequestHandlerResName()
int	getSnmpVersion()
javax.management.ObjectName	getTimerName()
long	getTrapCount() The current trap counter reading
java.lang.String	getTrapFactoryClassName()
long	getUptime() The up-time, in msecs.
java.lang.String	getUsersResName()
void	reconfigureRequestHandler() Reconfigures the RequestHandler, that is 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) The agent bind address
void	setDynamicSubscriptions(boolean dynamicSubscriptions) Enables/disables dynamic subscriptions
void	setHeartBeatPeriod(int heartBeatPeriod) The heartbeat period (in seconds) - 0 disables heartbeat
void	setManagersResName(java.lang.String managersResName) The name of the file containing SNMP manager specifications
void	setNotificationMapResName(java.lang.String notificationMapResName) The name of the file containing the notification/trap mappings
void	setNumberOfThreads(int numberOfThreads) The number of threads in the agent request processing thread pool
void	setPort(int port) The agent listening port number
void	setReadCommunity(java.lang.String readCommunity) The read community (no getter)
void	setRequestHandlerClassName(java.lang.String requestHandlerClassName) The RequestHandler implementation class
void	setRequestHandlerResName(java.lang.String requestHandlerResName) The resource file name containing get/set mappings
void	setSnmpVersion(int snmpVersion) The snmp protocol version
void	setTimerName(javax.management.ObjectName timerName) The utilised timer MBean name
void	setTrapFactoryClassName(java.lang.String name) 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) The write community (no getter)

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

OBJECT_NAME

static final javax.management.ObjectName OBJECT_NAME

Default ObjectName

Method Detail

setManagersResName

void setManagersResName(java.lang.String managersResName)

The name of the file containing SNMP manager specifications

getManagersResName

java.lang.String getManagersResName()

setUsersResName

void setUsersResName(java.lang.String usersResName)

The name of the file containing SNMPv3 users

getUsersResName

java.lang.String getUsersResName()

setNotificationMapResName

void setNotificationMapResName(java.lang.String notificationMapResName)

The name of the file containing the notification/trap mappings

getNotificationMapResName

java.lang.String getNotificationMapResName()

setRequestHandlerResName

void setRequestHandlerResName(java.lang.String requestHandlerResName)

The resource file name containing get/set mappings

getRequestHandlerResName

java.lang.String getRequestHandlerResName()

setTrapFactoryClassName

void setTrapFactoryClassName(java.lang.String name)

The utilised trap factory name

getTrapFactoryClassName

java.lang.String getTrapFactoryClassName()

setRequestHandlerClassName

void setRequestHandlerClassName(java.lang.String requestHandlerClassName)

The RequestHandler implementation class

getRequestHandlerClassName

java.lang.String getRequestHandlerClassName()

setTimerName

void setTimerName(javax.management.ObjectName timerName)

The utilised timer MBean name

getTimerName

javax.management.ObjectName getTimerName()

setDynamicSubscriptions

void setDynamicSubscriptions(boolean dynamicSubscriptions)

Enables/disables dynamic subscriptions

getDynamicSubscriptions

boolean getDynamicSubscriptions()

setBindAddress

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

The agent bind address

Throws:

java.net.UnknownHostException

getBindAddress

java.lang.String getBindAddress()

setHeartBeatPeriod

void setHeartBeatPeriod(int heartBeatPeriod)

The heartbeat period (in seconds) - 0 disables heartbeat

getHeartBeatPeriod

int getHeartBeatPeriod()

setPort

void setPort(int port)

The agent listening port number

getPort

int getPort()

setNumberOfThreads

void setNumberOfThreads(int numberOfThreads)

The number of threads in the agent request processing thread pool

getNumberOfThreads

int getNumberOfThreads()

setSnmpVersion

void setSnmpVersion(int snmpVersion)

The snmp protocol version

getSnmpVersion

int getSnmpVersion()

setReadCommunity

void setReadCommunity(java.lang.String readCommunity)

The read community (no getter)

setWriteCommunity

void setWriteCommunity(java.lang.String writeCommunity)

The write community (no getter)

getInstantiationTime

long getInstantiationTime()

The time difference (in msecs) between instantiation time and epoch (midnight, January 1, 1970 UTC)

getUptime

long getUptime()

The up-time, in msecs.

getTrapCount

long getTrapCount()

The current trap counter reading

sendJMXNotification

void sendJMXNotification(javax.management.Notification notification)

getNextJMXNotificationSequenceNumber

long getNextJMXNotificationSequenceNumber()

addAttributeMappings

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

removeAttributeMappings

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

addNotifications

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

removeNotifications

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

reconfigureRequestHandler

void reconfigureRequestHandler()
                               throws java.lang.Exception

Reconfigures the RequestHandler, that is reponsible for handling get requests etc.

Throws:

java.lang.Exception