org.snmp4j.agent.agentx.master

Class AgentXMasterAgent

java.lang.Object

org.snmp4j.agent.AgentConfigManager

org.snmp4j.agent.agentx.master.AgentXMasterAgent

All Implemented Interfaces:

Runnable, EventListener, org.snmp4j.transport.TransportStateListener

public class AgentXMasterAgent
extends org.snmp4j.agent.AgentConfigManager
implements org.snmp4j.transport.TransportStateListener

The AgentXMasterAgent is the base agent class for AgentX master agents. It extends the AgentConfigManager class provided by SNMP4J-Agent.

To implement a master agent, simply extend this class instead of AgentConfigManager as you would do for a non-AgentX agent.

Version:

1.1

Author:

Frank Fock

Nested Class Summary

Nested classes/interfaces inherited from class org.snmp4j.agent.AgentConfigManager

org.snmp4j.agent.AgentConfigManager.AgentState

Field Summary

Fields inherited from class org.snmp4j.agent.AgentConfigManager

agent, communityMIB, configuration, defaultContext, dispatcher, engineBootsProvider, engineID, frameworkMIB, moFactory, notificaitonLogGlobalAge, notificaitonLogGlobalLimit, notificationLogDefaultLimit, notificationLogMIB, notificationMIB, notificationOriginator, persistenceImportMode, persistenceProvider, proxyForwarder, proxyMIB, runState, servers, session, snmp4jConfigMIB, snmp4jLogMIB, snmp4jProxyMIB, snmpMpdMib, snmpv2MIB, STATE_CONFIGURED, STATE_CREATED, STATE_INITIALIZED, STATE_RESTORED, STATE_RUNNING, STATE_SAVED, STATE_SHUTDOWN, STATE_SUSPENDED, STATE_UNSAVED_CHANGES, sysDescr, sysOID, sysServices, tableSizeLimit, targetMIB, tlsTmMib, usm, usmMIB, vacm, vacmMIB, workerPool

Constructor Summary

Constructors

Constructor and Description
AgentXMasterAgent(File bootCounterFile, File configFile) Creates a simple AgentX master agent using a boot counter file and config file for persistent storage.
AgentXMasterAgent(org.snmp4j.smi.OctetString agentsOwnEngineID, org.snmp4j.MessageDispatcher messageDispatcher, org.snmp4j.agent.security.VACM vacm, org.snmp4j.agent.MOServer[] moServers, org.snmp4j.util.WorkerPool workerPool, org.snmp4j.agent.io.MOInputFactory configurationFactory, org.snmp4j.agent.io.MOPersistenceProvider persistenceProvider, org.snmp4j.agent.cfg.EngineBootsProvider engineBootsProvider) Creates a SNMP agent configuration which can be run by calling AgentConfigManager.run() later.

Method Summary

Modifier and Type	Method and Description
void	addAgentXTransportMapping(org.snmp4j.TransportMapping transport)
void	connectionStateChanged(org.snmp4j.transport.TransportStateEvent change)
protected org.snmp4j.agent.CommandProcessor	createCommandProcessor(org.snmp4j.smi.OctetString engineID) Creates the command processor.
AgentXMib	getAgentXMIB()
AgentXCommandProcessor	getCommandProcessor()
org.snmp4j.smi.OctetString	getLocalEngineID() Gets the local engine ID.
static short	getMaxGetBulkRepetitions() Gets the upper limit for AgentX Get Bulk repetitions field send on behalf of all master agents of this JVM.
boolean	isLocalhostSubagentsOnly() Indicates whether only subagents from the local host or from any host are allowed to connect to this master agent (default is any host).
protected void	launchTransportMappings() Launch (or relaunch) AgentX transport mappings.
protected void	registerMIBs(org.snmp4j.smi.OctetString context)
void	removeAgentXTransportMapping(org.snmp4j.TransportMapping transport)
void	setLocalEngineID(org.snmp4j.smi.OctetString localEngineID) Sets the local engine ID.
void	setLocalhostSubagentsOnly(boolean localhostSubagentsOnly) Sets the local host only connection filter flag.
static void	setMaxGetBulkRepetitions(short maxRepetitions) Sets the maximum repetitions value used by this master agent for its AgentX Get Bulk requests to subagents.
void	shutdown() Shutdown communication be stopping all AgentX transport mappings.
protected void	unregisterMIBs(org.snmp4j.smi.OctetString context)

Methods inherited from class org.snmp4j.agent.AgentConfigManager

configure, continueProcessing, createNotificationOriginator, createProxyForwarder, createSnmpSession, createTSM, createUSM, fireLaunchNotifications, getAgentNotificationOriginator, getContext, getDefaultContext, getNotificationLogMIB, getNotificationOriginator, getPersistenceImportMode, getSnmp4jConfigMIB, getSnmp4jLogMIB, getSnmp4jProxyMIB, getSnmpCommunityMIB, getSnmpMpdMib, getSnmpNotificationMIB, getSnmpTargetMIB, getSNMPv2MIB, getState, getSupportedSecurityProtocols, getSysDescr, getSysOID, getSysServices, getSysUpTime, getUsm, getUsmMIB, getVACM, getVacmMIB, initialize, initMandatoryMIBs, initMessageDispatcherWithMPs, initNotificationLogMIB, initOptionalMIBs, initSecurityModels, initSnmp4jConfigMIB, initSnmp4jLogMIB, initSnmp4jProxyMIB, launch, launchTransportMappings, linkCounterListener, registerShutdownHook, registerTransportMappings, restoreState, run, saveState, setNotificationOriginator, setPersistenceImportMode, setTableSizeLimit, setTableSizeLimits, setupProxyForwarder, stopTransportMappings, suspendProcessing

Methods inherited from class java.lang.Object

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

Constructor Detail

AgentXMasterAgent

public AgentXMasterAgent(org.snmp4j.smi.OctetString agentsOwnEngineID,
                         org.snmp4j.MessageDispatcher messageDispatcher,
                         org.snmp4j.agent.security.VACM vacm,
                         org.snmp4j.agent.MOServer[] moServers,
                         org.snmp4j.util.WorkerPool workerPool,
                         org.snmp4j.agent.io.MOInputFactory configurationFactory,
                         org.snmp4j.agent.io.MOPersistenceProvider persistenceProvider,
                         org.snmp4j.agent.cfg.EngineBootsProvider engineBootsProvider)

Creates a SNMP agent configuration which can be run by calling AgentConfigManager.run() later.

Parameters:

agentsOwnEngineID - the authoritative engine ID of the agent.

messageDispatcher - the MessageDispatcher to use. The message dispatcher must be configured outside, i.e. transport mappings have to be added before this constructor is being called.

vacm - a view access control model. Typically, this parameter is set to null to use the default VACM associated with the VacmMIB.

moServers - the managed object server(s) that server the managed objects available to this agent.

workerPool - the WorkerPool to be used to process incoming request.

configurationFactory - a MOInputFactory that creates a MOInput stream with containing serialized ManagedObject information with the agent's configuration or null otherwise.

persistenceProvider - the primary MOPersistenceProvider to be used to load and store persistent MOs.

engineBootsProvider - the provider of engine boots counter.

AgentXMasterAgent

public AgentXMasterAgent(File bootCounterFile,
                         File configFile)

Creates a simple AgentX master agent using a boot counter file and config file for persistent storage.

Parameters:

bootCounterFile - a file that stores the boot counter.

configFile - a file that stores persistent MIB data.

Method Detail

createCommandProcessor

protected org.snmp4j.agent.CommandProcessor createCommandProcessor(org.snmp4j.smi.OctetString engineID)

Creates the command processor.

Overrides:

createCommandProcessor in class org.snmp4j.agent.AgentConfigManager

Parameters:

engineID - the engine ID of the agent.

Returns:

a new CommandProcessor instance.

addAgentXTransportMapping

public void addAgentXTransportMapping(org.snmp4j.TransportMapping transport)

removeAgentXTransportMapping

public void removeAgentXTransportMapping(org.snmp4j.TransportMapping transport)

getMaxGetBulkRepetitions

public static short getMaxGetBulkRepetitions()

Gets the upper limit for AgentX Get Bulk repetitions field send on behalf of all master agents of this JVM.

Returns:

the upper limit for the maximum repetitions field for AgentX Get Bulk requests.

See Also:

setMaxGetBulkRepetitions(short)

getAgentXMIB

public AgentXMib getAgentXMIB()

getCommandProcessor

public AgentXCommandProcessor getCommandProcessor()

getLocalEngineID

public org.snmp4j.smi.OctetString getLocalEngineID()

Gets the local engine ID.

Returns:

the engine ID of the master agent.

isLocalhostSubagentsOnly

public boolean isLocalhostSubagentsOnly()

Indicates whether only subagents from the local host or from any host are allowed to connect to this master agent (default is any host).

Returns:

true if only connections from the local host are allowed and false if connections from any host are allowed.

setMaxGetBulkRepetitions

public static void setMaxGetBulkRepetitions(short maxRepetitions)

Sets the maximum repetitions value used by this master agent for its AgentX Get Bulk requests to subagents. The default is the maximum short value. The SNMP GETBULK request already defines a maximum repetitions value that is always the upper limit also for AgentX Get Bulk requests on its behalf.

The NET-SNMP AgentX sub-agent has a bug in its AgentX Get Bulk processing that causes endless loops in the sub-agent when the max-repetitions value is greater than one. Since this bug is in NET-SNMP since v4.2 and still present in version 5.4, it is likely, that you will need to set this value to one, if your master agent should ever communicate with a NET-SNMP sub-agent.

Parameters:

maxRepetitions - the upper limit of the maximum repetitions for AgentX Get Bulk sub-requests.

setLocalEngineID

public void setLocalEngineID(org.snmp4j.smi.OctetString localEngineID)

Sets the local engine ID. This method must not be called after AgentConfigManager.initialize() has been called for the first time.

Parameters:

localEngineID - the (authoritative) engine ID of the master agent.

setLocalhostSubagentsOnly

public void setLocalhostSubagentsOnly(boolean localhostSubagentsOnly)

Sets the local host only connection filter flag.

Parameters:

localhostSubagentsOnly - true if only connections from the local host are allowed and false if connections from any host are allowed.

connectionStateChanged

public void connectionStateChanged(org.snmp4j.transport.TransportStateEvent change)

Specified by:

connectionStateChanged in interface org.snmp4j.transport.TransportStateListener

registerMIBs

protected void registerMIBs(org.snmp4j.smi.OctetString context)
                     throws org.snmp4j.agent.DuplicateRegistrationException

Overrides:

registerMIBs in class org.snmp4j.agent.AgentConfigManager

Throws:

org.snmp4j.agent.DuplicateRegistrationException

unregisterMIBs

protected void unregisterMIBs(org.snmp4j.smi.OctetString context)

Overrides:

unregisterMIBs in class org.snmp4j.agent.AgentConfigManager

launchTransportMappings

protected void launchTransportMappings()
                                throws IOException

Launch (or relaunch) AgentX transport mappings.

Overrides:

launchTransportMappings in class org.snmp4j.agent.AgentConfigManager

Throws:

IOException - if the necessary ports could not be opened or bound.

shutdown

public void shutdown()

Shutdown communication be stopping all AgentX transport mappings.

Overrides:

shutdown in class org.snmp4j.agent.AgentConfigManager