org.waarp.snmp

Class WaarpSnmpAgent

java.lang.Object

org.snmp4j.agent.BaseAgent

org.waarp.snmp.WaarpSnmpAgent

All Implemented Interfaces:

Runnable

public class WaarpSnmpAgent
extends org.snmp4j.agent.BaseAgent

This Agent contains some functionalities for running a version 2c and 3 of SNMP agent.

Field Summary

Fields inherited from class org.snmp4j.agent.BaseAgent

agent, agentState, bootCounterFile, configFileURI, defaultContext, defaultPersistenceProvider, defaultProxyForwarder, dispatcher, mpv3, notificationOriginator, server, session, snmp4jConfigMIB, snmp4jLogMIB, snmpCommunityMIB, snmpFrameworkMIB, snmpMpdMib, snmpNotificationMIB, snmpProxyMIB, snmpTargetMIB, snmpv2MIB, STATE_CREATED, STATE_INIT_FINISHED, STATE_INIT_STARTED, STATE_RUNNING, STATE_STOPPED, sysDescr, sysOID, sysServices, transportMappings, usm, usmMIB, vacmMIB

Constructor Summary

Constructors

Constructor and Description
WaarpSnmpAgent(File configurationFile, WaarpInterfaceMonitor monitor, WaarpInterfaceMib mib)

Method Summary

Modifier and Type	Method and Description
protected void	addCommunities(org.snmp4j.agent.mo.snmp.SnmpCommunityMIB communityMIB) The table of community strings configured in the SNMP engine's Local Configuration Datastore (LCD).
protected void	addNotificationTargets(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB, org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB) Adds initial notification targets and filters.
protected void	addUsmUser(org.snmp4j.security.USM usm) Adds all the necessary initial users to the USM.
protected void	addViews(org.snmp4j.agent.mo.snmp.VacmMIB vacm) Minimal View based Access Control http://www.faqs.org/rfcs/rfc2575.html
WaarpInterfaceMib	getMib()
WaarpInterfaceMonitor	getMonitor()
int	getTrapLevel()
long	getUptime()
long	getUptimeSystemTime()
protected void	initTransportMappings()
protected void	registerManagedObjects() Register additional managed objects at the agent's server.
protected void	sendColdStartNotification()
protected void	sendShutdownNotification() Send a Notification just before Shutdown the SNMP service.
void	setTrapLevel(int trapLevel)
void	start() Start method invokes some initialization methods needed to start the agent
void	stop()
void	unregisterManagedObject(org.snmp4j.agent.MOGroup moGroup)
protected void	unregisterManagedObjects() Unregister the basic MIB modules from the agent's MOServer.

Methods inherited from class org.snmp4j.agent.BaseAgent

addShutdownHook, finishInit, getAgent, getAgentState, getBootCounterFile, getConfigFile, getContext, getDefaultContext, getDefaultProxyForwarder, getEngineBoots, getMPv3, getNotificationOriginator, getServer, getSession, getSnmp4jConfigMIB, getSnmp4jLogMIB, getSnmpCommunityMIB, getSnmpFrameworkMIB, getSnmpMpdMib, getSnmpNotificationMIB, getSnmpProxyMIB, getSnmpTargetMIB, getSnmpv2MIB, getSysDescr, getSysOID, getSysServices, getUsm, getUsmMIB, getVacmMIB, init, initConfigMIB, initMessageDispatcher, initSnmpSession, loadConfig, registerSnmpMIBs, run, saveConfig, setAgent, setBootCounterFile, setConfigFile, setDefaultContext, setDefaultProxyForwarder, setSysDescr, setSysOID, setSysServices, setupDefaultProxyForwarder, unregisterSnmpMIBs, updateEngineBoots, updateSession

Methods inherited from class java.lang.Object

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

Constructor Detail

WaarpSnmpAgent

public WaarpSnmpAgent(File configurationFile,
                      WaarpInterfaceMonitor monitor,
                      WaarpInterfaceMib mib)
               throws IllegalArgumentException

Parameters:

configurationFile - XML format

monitor - the associated monitor

mib - the associated MIB

Throws:

IllegalArgumentException

Method Detail

getMonitor

public final WaarpInterfaceMonitor getMonitor()

Returns:

the monitor

getMib

public final WaarpInterfaceMib getMib()

Returns:

the mib

getUptime

public final long getUptime()

Returns:

the uptime in ms

getUptimeSystemTime

public final long getUptimeSystemTime()

Returns:

the uptime but in System time in ms

registerManagedObjects

protected final void registerManagedObjects()

Register additional managed objects at the agent's server.

Specified by:

registerManagedObjects in class org.snmp4j.agent.BaseAgent

unregisterManagedObjects

protected final void unregisterManagedObjects()

Unregister the basic MIB modules from the agent's MOServer.

Specified by:

unregisterManagedObjects in class org.snmp4j.agent.BaseAgent

unregisterManagedObject

public final void unregisterManagedObject(org.snmp4j.agent.MOGroup moGroup)

Parameters:

moGroup -

addUsmUser

protected final void addUsmUser(org.snmp4j.security.USM usm)

Adds all the necessary initial users to the USM. Only applicable to SNMP V3

Specified by:

addUsmUser in class org.snmp4j.agent.BaseAgent

addNotificationTargets

protected final void addNotificationTargets(org.snmp4j.agent.mo.snmp.SnmpTargetMIB targetMIB,
                                            org.snmp4j.agent.mo.snmp.SnmpNotificationMIB notificationMIB)

Adds initial notification targets and filters.

Specified by:

addNotificationTargets in class org.snmp4j.agent.BaseAgent

addViews

protected final void addViews(org.snmp4j.agent.mo.snmp.VacmMIB vacm)

Minimal View based Access Control

http://www.faqs.org/rfcs/rfc2575.html

Specified by:

addViews in class org.snmp4j.agent.BaseAgent

addCommunities

protected final void addCommunities(org.snmp4j.agent.mo.snmp.SnmpCommunityMIB communityMIB)

The table of community strings configured in the SNMP engine's Local Configuration Datastore (LCD).

We only configure one, "public".

Specified by:

addCommunities in class org.snmp4j.agent.BaseAgent

initTransportMappings

protected final void initTransportMappings()
                                    throws IOException

Overrides:

initTransportMappings in class org.snmp4j.agent.BaseAgent

Throws:

IOException

start

public final void start()
                 throws IOException

Start method invokes some initialization methods needed to start the agent

Throws:

IOException

sendColdStartNotification

protected final void sendColdStartNotification()

Overrides:

sendColdStartNotification in class org.snmp4j.agent.BaseAgent

sendShutdownNotification

protected final void sendShutdownNotification()

Send a Notification just before Shutdown the SNMP service.

stop

public final void stop()

Overrides:

stop in class org.snmp4j.agent.BaseAgent

getTrapLevel

public final int getTrapLevel()

Returns:

the trapLevel

setTrapLevel

public final void setTrapLevel(int trapLevel)

Parameters:

trapLevel - the trapLevel to set