org.opends.server.admin.std.server
Interface SNMPConnectionHandlerCfg

All Superinterfaces:
Configuration, ConnectionHandlerCfg

public interface SNMPConnectionHandlerCfg
extends ConnectionHandlerCfg

A server-side interface for querying SNMP Connection Handler settings.

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.


Method Summary
 void addSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
          Register to be notified when this SNMP Connection Handler is changed.
 java.lang.Class<? extends SNMPConnectionHandlerCfg> configurationClass()
          Gets the configuration class associated with this SNMP Connection Handler.
 java.util.SortedSet<java.lang.String> getAllowedManager()
          Gets the "allowed-manager" property.
 java.util.SortedSet<java.lang.String> getAllowedUser()
          Gets the "allowed-user" property.
 java.lang.String getCommunity()
          Gets the "community" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 int getListenPort()
          Gets the "listen-port" property.
 java.lang.String getOpendmkJarfile()
          Gets the "opendmk-jarfile" property.
 java.lang.String getSecurityAgentFile()
          Gets the "security-agent-file" property.
 SNMPConnectionHandlerCfgDefn.SecurityLevel getSecurityLevel()
          Gets the "security-level" property.
 int getTrapPort()
          Gets the "trap-port" property.
 java.lang.String getTrapsCommunity()
          Gets the "traps-community" property.
 java.util.SortedSet<java.lang.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.
 
Methods inherited from interface org.opends.server.admin.std.server.ConnectionHandlerCfg
addChangeListener, getAllowedClient, getDeniedClient, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends SNMPConnectionHandlerCfg> configurationClass()
Gets the configuration class associated with this SNMP Connection Handler.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface ConnectionHandlerCfg
Returns:
Returns the configuration class associated with this SNMP Connection Handler.

addSNMPChangeListener

void addSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
Register to be notified when this SNMP Connection Handler is changed.

Parameters:
listener - The SNMP Connection Handler configuration change listener.

removeSNMPChangeListener

void removeSNMPChangeListener(ConfigurationChangeListener<SNMPConnectionHandlerCfg> listener)
Deregister an existing SNMP Connection Handler configuration change listener.

Parameters:
listener - The SNMP Connection Handler configuration change listener.

getAllowedManager

java.util.SortedSet<java.lang.String> getAllowedManager()
Gets the "allowed-manager" property.

Specifies the hosts of the managers to be granted the access rights. This property is required for SNMP v1 and v2 security configuration. An asterik (*) opens access to all managers.

Returns:
Returns an unmodifiable set containing the values of the "allowed-manager" property.

getAllowedUser

java.util.SortedSet<java.lang.String> getAllowedUser()
Gets the "allowed-user" property.

Specifies the users to be granted the access rights. This property is required for SNMP v3 security configuration. An asterik (*) opens access to all users.

Returns:
Returns an unmodifiable set containing the values of the "allowed-user" property.

getCommunity

java.lang.String getCommunity()
Gets the "community" property.

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.

Returns:
Returns the value of the "community" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.

Specified by:
getJavaClass in interface ConnectionHandlerCfg
Returns:
Returns the value of the "java-class" property.

getListenPort

int getListenPort()
Gets the "listen-port" property.

Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.

Only a single port number may be provided.

Returns:
Returns the value of the "listen-port" property.

getOpendmkJarfile

java.lang.String getOpendmkJarfile()
Gets the "opendmk-jarfile" property.

Indicates the OpenDMK runtime jar file location

Returns:
Returns the value of the "opendmk-jarfile" property.

isRegisteredMbean

boolean isRegisteredMbean()
Gets the "registered-mbean" property.

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.

Returns:
Returns the value of the "registered-mbean" property.

getSecurityAgentFile

java.lang.String getSecurityAgentFile()
Gets the "security-agent-file" property.

Specifies the USM security configuration to receive authenticated only SNMP requests.

Returns:
Returns the value of the "security-agent-file" property.

getSecurityLevel

SNMPConnectionHandlerCfgDefn.SecurityLevel getSecurityLevel()
Gets the "security-level" property.

Specifies the type of security level : NoAuthNoPriv : No security mechanisms activated, AuthNoPriv : Authentication activated with no privacy, AuthPriv : Authentication with privacy activated. This property id required for SNMP V3 security configuration.

Returns:
Returns the value of the "security-level" property.

getTrapPort

int getTrapPort()
Gets the "trap-port" property.

Specifies the port to use to send SNMP Traps.

Returns:
Returns the value of the "trap-port" property.

getTrapsCommunity

java.lang.String getTrapsCommunity()
Gets the "traps-community" property.

Specifies the community string that must be include in the traps sent to define managers (trap-destinations). This property is used in the context of SNMP v1, v2 and v3.

Returns:
Returns the value of the "traps-community" property.

getTrapsDestination

java.util.SortedSet<java.lang.String> getTrapsDestination()
Gets the "traps-destination" property.

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.

Returns:
Returns an unmodifiable set containing the values of the "traps-destination" property.