Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addListenAddresses(MessageDispatcher, List) - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
Parses the given address strings and adds a matching
TransportMappingfor each to the providedMessageDispatcher. - afterMOChange(MOChangeEvent) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
A change has been committed.
- afterPrepareMOChange(MOChangeEvent) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
A change has been prepared.
- agent - Variable in class org.snmp4j.agent.db.sample.SampleAgent
-
The agent configuration manager that controls and runs this sample agent.
- agentStateChanged(AgentConfigManager, AgentState) - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
The agent state has changed to the new state as provided.
- algorithmId - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
The full algorithm identifier this specification was parsed from.
B
- beforeMOChange(MOChangeEvent) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
A ManagedObject change is being committed.
- beforePrepareMOChange(MOChangeEvent) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
A ManagedObject change is being prepared.
C
- checkForModificationsOnSave - Enum constant in enum class org.snmp4j.agent.db.MOXodusPersistence.SavingStrategy
-
Save only when the
MOXodusPersistence.save()method is being called and the persistent data do no longer match the data in the agent. - checkMinVersionOfDependencies() - Static method in class org.snmp4j.agent.db.version.VersionInfo
-
Checks whether all dependencies have the minimum required version.
- cipherTransformation - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
The cipher transformation (e.g.
- close() - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Close the Xodus environment (DB) used by the default persistence located at
MOXodusPersistenceProvider.getDefaultURI(). - COMMAND_LINE_OPTIONS - Static variable in class org.snmp4j.agent.db.sample.SampleAgent
-
The
ArgumentParserformat string describing the supported command line options. - COMMAND_LINE_PARAMS - Static variable in class org.snmp4j.agent.db.sample.SampleAgent
-
The
ArgumentParserformat string describing the required command line parameters. - createMOInputFactory(String, ImportMode) - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
Creates a
MOInputFactorythat supplies the initial agent configuration from a properties file. - createStore(Transaction, OctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Ceates a
Storefor a context.
D
- decodeEncryptedSecretOctetString(BERInputStream) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Decodes a BER SEQUENCE that wraps an encrypted
SecretOctetStringand returns the decrypted value asSecretOctetString. - decodeIndexOID(BERInputStream, BER.MutableByte) - Static method in class org.snmp4j.agent.db.MOXodusPersistence
-
Decode a index
OIDfrom a BER input stream. - decodeInstanceData(ByteIterable) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Decode BER instance data from raw byte stream.
- decodeVariableBinding(BERInputStream) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Decode a
VariableBindingfrom anBERInputStream. - DEFAULT_ENCRYPTION_ALGORITHM - Static variable in class org.snmp4j.agent.db.MOXodusPersistence
-
The default encryption algorithm identifier used by
MOXodusPersistencefor protectingSecretOctetStringvalues stored to disk. - DEPENDENCY_SNMP4J_AGENT_MAJOR - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required major version of the SNMP4J-Agent dependency.
- DEPENDENCY_SNMP4J_AGENT_MINOR - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required minor version of the SNMP4J-Agent dependency.
- DEPENDENCY_SNMP4J_AGENT_PATCH - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required patch suffix of the SNMP4J-Agent dependency.
- DEPENDENCY_SNMP4J_AGENT_UPDATE - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required update version of the SNMP4J-Agent dependency.
- DEPENDENCY_SNMP4J_MAJOR - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required major version of the SNMP4J dependency.
- DEPENDENCY_SNMP4J_MINOR - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required minor version of the SNMP4J dependency.
- DEPENDENCY_SNMP4J_PATCH - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required patch suffix of the SNMP4J dependency.
- DEPENDENCY_SNMP4J_UPDATE - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minimum required update version of the SNMP4J dependency.
- deriveKey(char[], byte[], MOXodusPersistence.EncryptionSpec) - Method in class org.snmp4j.agent.db.MOXodusPersistence
E
- encodeIndexOID(OutputStream, byte, int[]) - Static method in class org.snmp4j.agent.db.MOXodusPersistence
-
Encodes an index OID.
- encodeInstanceData(List) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Encode instance data from a list of
VariableBindings. - encodeVariableBinding(VariableBinding, BEROutputStream) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Encode a
VariableBindingto aBEROutputStream. - encodeVariableBinding(VariableBinding, BEROutputStream, byte[]) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Encode a
VariableBindingwhere theVariablepart may already be available as a pre-computed BER byte sequence. - EncryptionSpec(String, String, int, String, int) - Constructor for class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
Creates a new encryption specification from its parsed components.
- encryptSecretToBerSequence(SecretOctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Encrypts a
SecretOctetStringvalue and returns the BER-encoded SEQUENCE that replaces the variable on the wire.
F
- fullDumpOnSave - Enum constant in enum class org.snmp4j.agent.db.MOXodusPersistence.SavingStrategy
-
Always save everything when
MOXodusPersistence.save()is being called without checking for modifications.
G
- gcm - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
trueif the cipher transformation uses GCM mode. - getContexts(ManagedObject) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Get the contexts registered with all
MOServerfor the givenManagedObject. - getDefaultEncryptionAlgorithm() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Returns the encryption algorithm identifier used to protect
SecretOctetStringvalues that are newly written to persistent storage. - getDefaultURI() - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Gets the URI of the default persistent storage for this provider.
- getEngineBoots() - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Returns current engine boot counter value.
- getEngineId(OctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
- getEnvironment() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Gets the Xodus
Environmentused by this persistent probvider. - getFactory() - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
Get the
MOFactorythat creates the various MOs (MIB Objects). - getIndexOIDLength(int[]) - Static method in class org.snmp4j.agent.db.MOXodusPersistence
-
Get the index OID length from a index OID raw value.
- getKey(OID, OID) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Gets the key for an OID and instance ID.
- getKeyOid(ByteIterable) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Gets the OID of a key.
- getMoScopeComparator() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Gets the
MOScopeComparatorthat defines the default order in whichManagedObjects are stored and restored from persistent storage (unless the parameterMOPriorityProvideris used). - getMOServer() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Get the associated
MOServers. - getPersistenceExceptionList() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Gets the current exception list for keeping
RandomAccessManagedObjects persistent regardless theirRandomAccessManagedObject.isVolatile()value or not. - getPersistenceProviderID() - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Returns a unique ID of the persistence provider which should identify the format and type of the persistence provider.
- getSavingStrategy() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Gets the saving strategy as defined by
MOXodusPersistence.SavingStrategy. - getTableSizeLimitsProperties(Map, AgentAuditPolicy) - Static method in class org.snmp4j.agent.db.sample.SampleAgent
-
Read the content of the
SampleAgentTableSizeLimits.propertiesfile. - getVersion() - Static method in class org.snmp4j.agent.db.version.VersionInfo
-
Gets the version string for this release.
I
- isContextLoadable(OctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Checks if there is already MIB data stored for the specified context.
- isContinuousChangeListening() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Return
trueif theMOXodusPersistence.registerChangeListenersWithServer(MOServer)for any server, butMOXodusPersistence.unregisterChangeListenersWithServer(MOServer)has not been called yet. - isEncryptionEnabled() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Returns
trueif a master password is configured andSecretOctetStringvalues will therefore be encrypted on save and decrypted on load. - isIgnoreChangeListenerEvents() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Check whether change listener events are actually suppressed (i.e. ignored) or not.
- isIgnoreEncryptedDataWithoutPassword() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Returns the flag controlling how encrypted secrets are handled when loading data without a master password set.
- isValidPersistenceURI(String) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Checks whether the supplied URI string is valid for this persistence provider.
- iterations - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
The number of iterations used by the key derivation function.
- ivBytes - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
The initialization vector size in bytes, derived from the cipher mode.
K
- kdf - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
The key derivation function (KDF) name.
- keyBits - Variable in class org.snmp4j.agent.db.MOXodusPersistence.EncryptionSpec
-
The key size in bits.
L
- load(ImportMode) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Loads the contents of all managed objects using the specified import mode and the default load order.
- load(ImportMode, MOPriorityProvider) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Load the contents of all
RandomAccessManagedObjects usingRandomAccessManagedObject.importInstance(OID, List, ImportMode)calls. - load(ImportMode, MOPriorityProvider, boolean) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Load the contents of all
RandomAccessManagedObjects usingRandomAccessManagedObject.importInstance(OID, List, ImportMode)calls.
M
- main(String[]) - Static method in class org.snmp4j.agent.db.sample.SampleAgent
-
Runs a sample agent with a default configuration defined by
SampleAgentConfig.properties. - MAJOR - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The major version number of this SNMP4J-Agent-DB release.
- MINOR - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The minor version number of this SNMP4J-Agent-DB release.
- MOXodusPersistence - Class in org.snmp4j.agent.db
-
The
MOXodusPersistenceclass provides persistent storage for SNMP4J-Agent using theMOXodusPersistenceProviderwrapper that actually implements theMOPersistenceProviderinterface of SNMP4J-Agent. - MOXodusPersistence(MOServer[], Environment) - Constructor for class org.snmp4j.agent.db.MOXodusPersistence
- MOXodusPersistence(MOServer[], Environment, char[]) - Constructor for class org.snmp4j.agent.db.MOXodusPersistence
-
Creates a new
MOXodusPersistencefrom an array ofMOServerinstances, an XodusEnvironment, and a master password used to encrypt everySecretOctetStringvalue before it is written to persistent storage. - MOXodusPersistence(MOServer[], Environment, MOXodusPersistence.SavingStrategy) - Constructor for class org.snmp4j.agent.db.MOXodusPersistence
- MOXodusPersistence(MOServer[], Environment, MOXodusPersistence.SavingStrategy, MOScopeComparator) - Constructor for class org.snmp4j.agent.db.MOXodusPersistence
- MOXodusPersistence(MOServer[], Environment, MOXodusPersistence.SavingStrategy, MOScopeComparator, char[]) - Constructor for class org.snmp4j.agent.db.MOXodusPersistence
-
Creates a new
MOXodusPersistencewith explicitMOXodusPersistence.SavingStrategy, comparator and master password. - MOXodusPersistence.EncryptionSpec - Class in org.snmp4j.agent.db
-
A parsed representation of an algorithm identifier as accepted by
MOXodusPersistence.setDefaultEncryptionAlgorithm(String). - MOXodusPersistence.SavingStrategy - Enum Class in org.snmp4j.agent.db
-
The
MOXodusPersistence.SavingStrategydefines how and when persistent data is saved. - MOXodusPersistenceProvider - Class in org.snmp4j.agent.db
-
The
MOXodusPersistenceProviderimplements aMOPersistenceProviderthat uses a JetBrains Xodus database for persistent storage ofRandomAccessManagedObjects. - MOXodusPersistenceProvider(MOXodusPersistence) - Constructor for class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Deprecated.
- MOXodusPersistenceProvider(MOXodusPersistence, AgentAuditPolicy) - Constructor for class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Creates a
MOXodusPersistenceProviderbased with a provided defaultMOXodusPersistencehandler that provides the default storage access operations and listens forRandomAccessManagedObjectupdate events (seeMOXodusPersistence.registerChangeListenersWithServer(MOServer)for details).
O
- onChangeEventsOnly - Enum constant in enum class org.snmp4j.agent.db.MOXodusPersistence.SavingStrategy
-
The default strategy saves changed data only if a corresponding
MOChangeEventhas been received. - org.snmp4j.agent.db - package org.snmp4j.agent.db
- org.snmp4j.agent.db.sample - package org.snmp4j.agent.db.sample
- org.snmp4j.agent.db.version - package org.snmp4j.agent.db.version
P
- parseEncryptionAlgorithm(String) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Parses a
MOXodusPersistenceencryption algorithm identifier into a structuredMOXodusPersistence.EncryptionSpec. - PATCH - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The optional patch suffix of this SNMP4J-Agent-DB release.
R
- registerChangeListenersWithServer(MOServer) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Register this object as
MOChangeListeneron allRandomAccessManagedObjectinstances in the providedMOServer. - registerMIBs() - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
Register your own MIB modules in the specified context of the agent.
- resetEngineId(OctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
- restore(String, int) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Restore (load) agent state from the specified URI (can be as simple as a file path).
- restore(String, int, MOPriorityProvider) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Restore (load) agent state from the specified URI (can be as simple as a file path).
- run() - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
Initializes the agent, registers the sample MIB modules, applies the table size limits, registers a shutdown hook for persisting the configuration, and finally starts the agent.
- runSynchronization(Map, Transaction, ImportMode, Iterator, boolean) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Run synchronisation between in memory data and on disk data.
- runSyncOnBootMO(Transaction, MOServer, Map, ImportMode, MOPriorityProvider, OctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Run synchronisation on the boot
ManagedObject(i.e. theManagedObjectrestored before any other.
S
- SampleAgent - Class in org.snmp4j.agent.db.sample
-
The SampleAgent uses an
AgentConfigManagerinstance to create a minimal SNMP agent using the configuration defined bySampleAgentConfig.propertiesin this package. - SampleAgent(Map, AgentAuditPolicy) - Constructor for class org.snmp4j.agent.db.sample.SampleAgent
-
Creates a new
SampleAgentfrom the parsed command line arguments. - SampleAgent(Map, MOServer[], MOXodusPersistence, Properties, ImportMode, AgentAuditPolicy) - Constructor for class org.snmp4j.agent.db.sample.SampleAgent
-
Creates a new
SampleAgentwith explicitly provided servers, persistence, and table size limits. - save() - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Saves the data of the
MOServers associated with this instance to persistent storage depending on the currently configuredMOXodusPersistence.SavingStrategy. - save(MOPriorityProvider) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Saves the data of the
MOServers associated with this instance to persistent storage depending on the currently configuredMOXodusPersistence.SavingStrategy. - saveFullDump(MOPriorityProvider, boolean) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Saves the data of the
MOServers associated with this instance to persistent storage independent of the currently setMOXodusPersistence.SavingStrategy. - server - Variable in class org.snmp4j.agent.db.sample.SampleAgent
-
The managed object server that holds the managed objects served by this agent.
- setDefaultEncryptionAlgorithm(String) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Sets the encryption algorithm identifier used to protect
SecretOctetStringvalues that are subsequently written to persistent storage. - setIgnoreChangeListenerEvents(boolean) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Defines whether
MOChangeEvents should be ignored or not. - setIgnoreEncryptedDataWithoutPassword(boolean) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Controls how the persistence loader reacts when it encounters an encrypted
SecretOctetStringbut no master password has been configured. - setMoScopeComparator(MOScopeComparator) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Sets the
MOScopeComparatorand by this defines the default order in whichManagedObjects are stored and restored from persistent storage as long as parameterMOPriorityProviderofMOXodusPersistence.save(MOPriorityProvider)andMOXodusPersistence.load(ImportMode, MOPriorityProvider)are not used. - setPersistenceExceptionList(Map) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Sets the current exception list for keeping
RandomAccessManagedObjects persistent regardless theirRandomAccessManagedObject.isVolatile()value or not. - setSavingStrategy(MOXodusPersistence.SavingStrategy) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Sets the saving strategy for this persistence provider as defined by
MOXodusPersistence.SavingStrategy. - setupAgent(Map, MOServer[], MOInputFactory, List, String, AgentAuditPolicy) - Method in class org.snmp4j.agent.db.sample.SampleAgent
-
Sets up the
AgentConfigManagerincluding its message dispatcher, listen addresses, optional Diffie-Hellman kickstart parameters, and persistence provider. - store(String) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Stores the current agent state to persistent storage specified by the supplied URI.
- store(String, MOPriorityProvider) - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
- storeNameFromContext(OctetString) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Return a string store name for the provided SNMPv3 context.
T
- tableSizeLimits - Variable in class org.snmp4j.agent.db.sample.SampleAgent
-
The table size limits applied to the agent's tables, keyed by table OID.
U
- unregisterChangeListenersWithServer(MOServer) - Method in class org.snmp4j.agent.db.MOXodusPersistence
-
Removes a former registration of this object as
MOChangeListeneron allRandomAccessManagedObjectinstances in the providedMOServer. - UPDATE - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The update (micro) version number of this SNMP4J-Agent-DB release.
- updateEngineBoots() - Method in class org.snmp4j.agent.db.MOXodusPersistenceProvider
-
Returns the current engine boot counter value incremented by one.
V
- valueOf(String) - Static method in enum class org.snmp4j.agent.db.MOXodusPersistence.SavingStrategy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.snmp4j.agent.db.MOXodusPersistence.SavingStrategy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VERSION - Static variable in class org.snmp4j.agent.db.version.VersionInfo
-
The full version string of this SNMP4J-Agent-DB release.
- VersionInfo - Class in org.snmp4j.agent.db.version
-
The
VersionInfoobject returns information about the version of this SNMP4J-AgentX release.
All Classes and Interfaces|All Packages|Constant Field Values
MOXodusPersistenceProvider(MOXodusPersistence, AgentAuditPolicy)instead.