public interface SNMPConnectionHandlerCfg extends ConnectionHandlerCfg
The SNMP Connection Handler can be used to process SNMP requests to retrieve monitoring information described by the MIB 2605. Supported protocol are SNMP V1, V2c and V3.
Modifier and Type | Method and Description |
---|---|
void |
addSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
Register to be notified when this SNMP Connection Handler is changed.
|
Class<? extends SNMPConnectionHandlerCfg> |
configurationClass()
Gets the configuration class associated with this SNMP Connection Handler.
|
SortedSet<String> |
getAllowedManager()
Gets the "allowed-manager" property.
|
SortedSet<String> |
getAllowedUser()
Gets the "allowed-user" property.
|
String |
getCommunity()
Gets the "community" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
SortedSet<InetAddress> |
getListenAddress()
Gets the "listen-address" property.
|
int |
getListenPort()
Gets the "listen-port" property.
|
String |
getOpendmkJarfile()
Gets the "opendmk-jarfile" property.
|
String |
getSecurityAgentFile()
Gets the "security-agent-file" property.
|
SNMPConnectionHandlerCfgDefn.SecurityLevel |
getSecurityLevel()
Gets the "security-level" property.
|
int |
getTrapPort()
Gets the "trap-port" property.
|
String |
getTrapsCommunity()
Gets the "traps-community" property.
|
SortedSet<String> |
getTrapsDestination()
Gets the "traps-destination" property.
|
boolean |
isRegisteredMbean()
Gets the "registered-mbean" property.
|
void |
removeSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
Deregister an existing SNMP Connection Handler configuration change listener.
|
addChangeListener, getAllowedClient, getDeniedClient, isEnabled, removeChangeListener
dn
Class<? extends SNMPConnectionHandlerCfg> configurationClass()
configurationClass
in interface Configuration
configurationClass
in interface ConnectionHandlerCfg
void addSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
listener
- The SNMP Connection Handler configuration change listener.void removeSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
listener
- The SNMP Connection Handler configuration change listener.SortedSet<String> getAllowedManager()
Specifies the hosts of the managers to be granted the access rights. This property is required for SNMP v1 and v2 security configuration. An asterisk (*) opens access to all managers.
SortedSet<String> getAllowedUser()
Specifies the users to be granted the access rights. This property is required for SNMP v3 security configuration. An asterisk (*) opens access to all users.
String getCommunity()
Specifies the v1,v2 community or the v3 context name allowed to access the MIB 2605 monitoring information or the USM MIB. The mapping between "community" and "context name" is set.
String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
getJavaClass
in interface ConnectionHandlerCfg
SortedSet<InetAddress> getListenAddress()
Specifies the address or set of addresses on which this SNMP Connection Handler should listen for connections from SNMP clients.
Multiple addresses may be provided as separate values for this attribute. If no values are provided, then the SNMP Connection Handler listens on all interfaces.
int getListenPort()
Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.
Only a single port number may be provided.
String getOpendmkJarfile()
Indicates the OpenDMK runtime jar file location
boolean isRegisteredMbean()
Indicates whether the SNMP objects have to be registered in the directory server MBeanServer or not allowing to access SNMP Objects with RMI connector if enabled.
String getSecurityAgentFile()
Specifies the USM security configuration to receive authenticated only SNMP requests.
SNMPConnectionHandlerCfgDefn.SecurityLevel getSecurityLevel()
Specifies the type of security level : NoAuthNoPriv : No security mechanisms activated, AuthNoPriv : Authentication activated with no privacy, AuthPriv : Authentication with privacy activated. This property is required for SNMP V3 security configuration.
int getTrapPort()
Specifies the port to use to send SNMP Traps.
String getTrapsCommunity()
Specifies the community string that must be included in the traps sent to define managers (trap-destinations). This property is used in the context of SNMP v1, v2 and v3.
SortedSet<String> getTrapsDestination()
Specifies the hosts to which V1 traps will be sent. V1 Traps are sent to every host listed.
If this list is empty, V1 traps are sent to "localhost". Each host in the list must be identifed by its name or complete IP Addess.
Copyright 2010-2017 ForgeRock AS.