Class Snmp4jConfigMib

java.lang.Object

org.snmp4j.agent.mo.snmp4j.Snmp4jConfigMib

All Implemented Interfaces:

MOPriorityProvider, MOGroup

public class Snmp4jConfigMib
extends Object
implements MOGroup, MOPriorityProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Snmp4jConfigMib.Snmp4jCfgReset
static final class	Snmp4jConfigMib.Snmp4jCfgResetEnum
class	Snmp4jConfigMib.Snmp4jCfgSecSrcAddrValidation
static final class	Snmp4jConfigMib.Snmp4jCfgSecSrcAddrValidationEnum
class	Snmp4jConfigMib.Snmp4jCfgStorageEntryRow
static final class	Snmp4jConfigMib.Snmp4jCfgStorageFormatEnum
static final class	Snmp4jConfigMib.Snmp4jCfgStorageOperationEnum
static final class	Snmp4jConfigMib.Snmp4jCfgStorageRestoreModeEnum
class	Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRow
class	Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRowFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final int	colSnmp4jCfgStorageID
static final int	colSnmp4jCfgStorageLastRestore
static final int	colSnmp4jCfgStorageLastStore
static final int	colSnmp4jCfgStorageOperation
static final int	colSnmp4jCfgStoragePath
static final int	colSnmp4jCfgStorageRestoreMode
static final int	colSnmp4jCfgStorageSeqRowStatus
static final int	colSnmp4jCfgStorageSeqStorageType
static final int	colSnmp4jCfgStorageSeqSubtree
static final int	colSnmp4jCfgStorageStatus
static final int	colSnmp4jCfgStorageStorageType
static final int	idxSnmp4jCfgStorageID
static final int	idxSnmp4jCfgStorageLastRestore
static final int	idxSnmp4jCfgStorageLastStore
static final int	idxSnmp4jCfgStorageOperation
static final int	idxSnmp4jCfgStoragePath
static final int	idxSnmp4jCfgStorageRestoreMode
static final int	idxSnmp4jCfgStorageSeqRowStatus
static final int	idxSnmp4jCfgStorageSeqStorageType
static final int	idxSnmp4jCfgStorageSeqSubtree
static final int	idxSnmp4jCfgStorageStatus
static final int	idxSnmp4jCfgStorageStorageType
static final org.snmp4j.smi.OID	oidSnmp4jCfgReset
static final org.snmp4j.smi.OID	oidSnmp4jCfgSecSrcAddrValidation
static final org.snmp4j.smi.OID	oidSnmp4jCfgStorageEntry
static final org.snmp4j.smi.OID	oidSnmp4jCfgStorageSeqEntry
static final org.snmp4j.smi.OID	oidSnmp4jCfgStorageSeqIndex
protected Map<CharSequence, MOPersistenceProvider>	persistenceProvider
static final org.snmp4j.smi.OID	PRIMARY_INDEX
protected MOPersistenceProvider	primaryPersistence
protected SnmpCommunityMIB	snmpCommunityMIB
protected SysUpTime	sysUpTime

Constructor Summary

Constructors

Constructor	Description
Snmp4jConfigMib(SysUpTime sysUpTime)
Snmp4jConfigMib(SysUpTime sysUpTime, AgentConfigManager agentConfigManager)

Method Summary

Modifier and Type	Method	Description
void	addPersistenceProvider(MOPersistenceProvider provider)
void	freeRow(Snmp4jConfigMib.Snmp4jCfgStorageEntryRow row)
ManagedObject<?>	getBootManagedObject(org.snmp4j.smi.OctetString context)	This default implementation of MOPriorityProvider does not support context depend configurations.
SnmpCommunityMIB	getCoexistenceInfoProvider()
File	getConfigStoragePathRoot()	Gets the root folder that limits the directories allowed as value of the snmp4jCfgStoragePath object.
MOPersistenceProvider	getPersistenceProvider(String id)
MOPersistenceProvider	getPrimaryPersistence()
SortedMap<org.snmp4j.smi.OID, Integer>	getPriorityMap(org.snmp4j.smi.OctetString context)	Returns a sorted map that maps object identifiers to a integer based priority where lesser numbers represent higher priority, i.e. earlier processing in store and restore operations.
MOTable<Snmp4jConfigMib.Snmp4jCfgStorageEntryRow, MOColumn, MOMutableTableModel<Snmp4jConfigMib.Snmp4jCfgStorageEntryRow>>	getSnmp4jCfgStorageEntry()
MOTable<Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRow, MOColumn, MOMutableTableModel<Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRow>>	getSnmp4jCfgStorageSeqEntry()
void	registerMOs(MOServer server, org.snmp4j.smi.OctetString context)	Registers the managed objects of this group with the server for the supplied context.
void	setConfigStoragePathRoot(File configStoragePathRoot)	Sets the root folder that limits the directories allowed as value of the snmp4jCfgStoragePath object to the given folder and its sub-folders.
void	setPrimaryProvider(MOPersistenceProvider persistenceProvider)
void	setSnmpCommunityMIB(SnmpCommunityMIB snmpCommunityMIB)
void	unregisterMOs(MOServer server, org.snmp4j.smi.OctetString context)	Unregisters the managed objects of this group from the supplied server and from the supplied context.

Methods inherited from class Object

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

Field Details

oidSnmp4jCfgSecSrcAddrValidation

public static final org.snmp4j.smi.OID oidSnmp4jCfgSecSrcAddrValidation

oidSnmp4jCfgReset

public static final org.snmp4j.smi.OID oidSnmp4jCfgReset

oidSnmp4jCfgStorageEntry

public static final org.snmp4j.smi.OID oidSnmp4jCfgStorageEntry

colSnmp4jCfgStoragePath

public static final int colSnmp4jCfgStoragePath

See Also:

• Constant Field Values

colSnmp4jCfgStorageID

public static final int colSnmp4jCfgStorageID

See Also:

• Constant Field Values

colSnmp4jCfgStorageLastStore

public static final int colSnmp4jCfgStorageLastStore

See Also:

• Constant Field Values

colSnmp4jCfgStorageLastRestore

public static final int colSnmp4jCfgStorageLastRestore

See Also:

• Constant Field Values

colSnmp4jCfgStorageRestoreMode

public static final int colSnmp4jCfgStorageRestoreMode

See Also:

• Constant Field Values

colSnmp4jCfgStorageOperation

public static final int colSnmp4jCfgStorageOperation

See Also:

• Constant Field Values

colSnmp4jCfgStorageStorageType

public static final int colSnmp4jCfgStorageStorageType

See Also:

• Constant Field Values

colSnmp4jCfgStorageStatus

public static final int colSnmp4jCfgStorageStatus

See Also:

• Constant Field Values

idxSnmp4jCfgStoragePath

public static final int idxSnmp4jCfgStoragePath

See Also:

• Constant Field Values

idxSnmp4jCfgStorageID

public static final int idxSnmp4jCfgStorageID

See Also:

• Constant Field Values

idxSnmp4jCfgStorageLastStore

public static final int idxSnmp4jCfgStorageLastStore

See Also:

• Constant Field Values

idxSnmp4jCfgStorageLastRestore

public static final int idxSnmp4jCfgStorageLastRestore

See Also:

• Constant Field Values

idxSnmp4jCfgStorageRestoreMode

public static final int idxSnmp4jCfgStorageRestoreMode

See Also:

• Constant Field Values

idxSnmp4jCfgStorageOperation

public static final int idxSnmp4jCfgStorageOperation

See Also:

• Constant Field Values

idxSnmp4jCfgStorageStorageType

public static final int idxSnmp4jCfgStorageStorageType

See Also:

• Constant Field Values

idxSnmp4jCfgStorageStatus

public static final int idxSnmp4jCfgStorageStatus

See Also:

• Constant Field Values

oidSnmp4jCfgStorageSeqEntry

public static final org.snmp4j.smi.OID oidSnmp4jCfgStorageSeqEntry

oidSnmp4jCfgStorageSeqIndex

public static final org.snmp4j.smi.OID oidSnmp4jCfgStorageSeqIndex

colSnmp4jCfgStorageSeqSubtree

public static final int colSnmp4jCfgStorageSeqSubtree

See Also:

• Constant Field Values

colSnmp4jCfgStorageSeqStorageType

public static final int colSnmp4jCfgStorageSeqStorageType

See Also:

• Constant Field Values

colSnmp4jCfgStorageSeqRowStatus

public static final int colSnmp4jCfgStorageSeqRowStatus

See Also:

• Constant Field Values

idxSnmp4jCfgStorageSeqSubtree

public static final int idxSnmp4jCfgStorageSeqSubtree

See Also:

• Constant Field Values

idxSnmp4jCfgStorageSeqStorageType

public static final int idxSnmp4jCfgStorageSeqStorageType

See Also:

• Constant Field Values

idxSnmp4jCfgStorageSeqRowStatus

public static final int idxSnmp4jCfgStorageSeqRowStatus

See Also:

• Constant Field Values

PRIMARY_INDEX

public static final org.snmp4j.smi.OID PRIMARY_INDEX

snmpCommunityMIB

protected SnmpCommunityMIB snmpCommunityMIB

persistenceProvider

protected Map<CharSequence, MOPersistenceProvider> persistenceProvider

primaryPersistence

protected MOPersistenceProvider primaryPersistence

sysUpTime

protected SysUpTime sysUpTime

Constructor Details

Snmp4jConfigMib

public Snmp4jConfigMib(SysUpTime sysUpTime)

Snmp4jConfigMib

public Snmp4jConfigMib(SysUpTime sysUpTime,
 AgentConfigManager agentConfigManager)

Method Details

getSnmp4jCfgStorageEntry

public MOTable<Snmp4jConfigMib.Snmp4jCfgStorageEntryRow, MOColumn, MOMutableTableModel<Snmp4jConfigMib.Snmp4jCfgStorageEntryRow>> getSnmp4jCfgStorageEntry()

getPrimaryPersistence

public MOPersistenceProvider getPrimaryPersistence()

getSnmp4jCfgStorageSeqEntry

public MOTable<Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRow, MOColumn, MOMutableTableModel<Snmp4jConfigMib.Snmp4jCfgStorageSeqEntryRow>> getSnmp4jCfgStorageSeqEntry()

registerMOs

public void registerMOs(MOServer server,
 org.snmp4j.smi.OctetString context)
                 throws DuplicateRegistrationException

Description copied from interface: MOGroup

Registers the managed objects of this group with the server for the supplied context.

Specified by:

registerMOs in interface MOGroup

Parameters:

server - the MOServer where to register the managed objects.

context - the context to use (may be null if no specific context is selected).

Throws:

DuplicateRegistrationException - if a managed object's scope (i.e. lower bound) is already registered at the server.

unregisterMOs

public void unregisterMOs(MOServer server,
 org.snmp4j.smi.OctetString context)

Description copied from interface: MOGroup

Unregisters the managed objects of this group from the supplied server and from the supplied context.

Specified by:

unregisterMOs in interface MOGroup

Parameters:

server - the MOServer where to unregister the managed objects.

context - the context to use (may be null if no specific context is selected).

getPriorityMap

public SortedMap<org.snmp4j.smi.OID, Integer> getPriorityMap(org.snmp4j.smi.OctetString context)

Description copied from interface: MOPriorityProvider

Returns a sorted map that maps object identifiers to a integer based priority where lesser numbers represent higher priority, i.e. earlier processing in store and restore operations. The OIDs represent the lower bound of the MOScope of ManagedObjects or any of their parent sub-trees.

Specified by:

getPriorityMap in interface MOPriorityProvider

Parameters:

context - the SNMPv3 context for which the boot managed object that stores the priority information is to e returned. null and the empty (size 0) string represent the default context.

Returns:

a sorted map of OID to zero based priorities.

getBootManagedObject

public ManagedObject<?> getBootManagedObject(org.snmp4j.smi.OctetString context)

This default implementation of MOPriorityProvider does not support context depend configurations. Thus it will return for all contexts getSnmp4jCfgStorageEntry().

Specified by:

getBootManagedObject in interface MOPriorityProvider

Parameters:

context - the SNMPv3 context for which the boot managed object that stores the priority information is to e returned. null and the empty (size 0) string represent the default context.

Returns:

getSnmp4jCfgStorageEntry()

freeRow

public void freeRow(Snmp4jConfigMib.Snmp4jCfgStorageEntryRow row)

setSnmpCommunityMIB

public void setSnmpCommunityMIB(SnmpCommunityMIB snmpCommunityMIB)

setPrimaryProvider

public void setPrimaryProvider(MOPersistenceProvider persistenceProvider)

addPersistenceProvider

public void addPersistenceProvider(MOPersistenceProvider provider)

getPersistenceProvider

public MOPersistenceProvider getPersistenceProvider(String id)

getCoexistenceInfoProvider

public SnmpCommunityMIB getCoexistenceInfoProvider()

getConfigStoragePathRoot

public File getConfigStoragePathRoot()

Gets the root folder that limits the directories allowed as value of the snmp4jCfgStoragePath object.

Returns:

the root folder and its sub-folders are the only paths accepted by Snmp4jConfigMib.Snmp4jCfgStoragePathValidator, or null if any storage path modification is rejected with a notWritable error.

Since:

3.9.0

setConfigStoragePathRoot

public void setConfigStoragePathRoot(File configStoragePathRoot)

Sets the root folder that limits the directories allowed as value of the snmp4jCfgStoragePath object to the given folder and its sub-folders. Any attempt to set a storage path outside this folder is rejected with a genErr by Snmp4jConfigMib.Snmp4jCfgStoragePathValidator.

Parameters:

configStoragePathRoot - the root folder. If null, any modification of the snmp4jCfgStoragePath object is rejected with a notWritable error. If a folder with an empty path is provided, the working directory of the Java process (System.getProperty("user.dir", ".")) is used instead.

Since:

3.9.0