org.opends.server.admin.std.meta

Class SNMPConnectionHandlerCfgDefn

java.lang.Object

org.opends.server.admin.AbstractManagedObjectDefinition<C,S>

org.opends.server.admin.ManagedObjectDefinition<SNMPConnectionHandlerCfgClient,SNMPConnectionHandlerCfg>

org.opends.server.admin.std.meta.SNMPConnectionHandlerCfgDefn

public final class SNMPConnectionHandlerCfgDefn
extends ManagedObjectDefinition<SNMPConnectionHandlerCfgClient,SNMPConnectionHandlerCfg>

An interface for querying the SNMP Connection Handler managed object definition meta information.

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SNMPConnectionHandlerCfgDefn.SecurityLevel Defines the set of permissable values for the "security-level" property.

Method Summary

Methods

Modifier and Type	Method and Description
SNMPConnectionHandlerCfgClient	createClientConfiguration(ManagedObject<? extends SNMPConnectionHandlerCfgClient> impl) Creates a client configuration view of the provided managed object.
SNMPConnectionHandlerCfg	createServerConfiguration(ServerManagedObject<? extends SNMPConnectionHandlerCfg> impl) Creates a server configuration view of the provided server managed object.
IPAddressMaskPropertyDefinition	getAllowedClientPropertyDefinition() Get the "allowed-client" property definition.
StringPropertyDefinition	getAllowedManagerPropertyDefinition() Get the "allowed-manager" property definition.
StringPropertyDefinition	getAllowedUserPropertyDefinition() Get the "allowed-user" property definition.
StringPropertyDefinition	getCommunityPropertyDefinition() Get the "community" property definition.
IPAddressMaskPropertyDefinition	getDeniedClientPropertyDefinition() Get the "denied-client" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition() Get the "enabled" property definition.
static SNMPConnectionHandlerCfgDefn	getInstance() Get the SNMP Connection Handler configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition() Get the "java-class" property definition.
IPAddressPropertyDefinition	getListenAddressPropertyDefinition() Get the "listen-address" property definition.
IntegerPropertyDefinition	getListenPortPropertyDefinition() Get the "listen-port" property definition.
StringPropertyDefinition	getOpendmkJarfilePropertyDefinition() Get the "opendmk-jarfile" property definition.
BooleanPropertyDefinition	getRegisteredMbeanPropertyDefinition() Get the "registered-mbean" property definition.
StringPropertyDefinition	getSecurityAgentFilePropertyDefinition() Get the "security-agent-file" property definition.
EnumPropertyDefinition<SNMPConnectionHandlerCfgDefn.SecurityLevel>	getSecurityLevelPropertyDefinition() Get the "security-level" property definition.
Class<SNMPConnectionHandlerCfg>	getServerConfigurationClass() Gets the server configuration class instance associated with this managed object definition.
IntegerPropertyDefinition	getTrapPortPropertyDefinition() Get the "trap-port" property definition.
StringPropertyDefinition	getTrapsCommunityPropertyDefinition() Get the "traps-community" property definition.
StringPropertyDefinition	getTrapsDestinationPropertyDefinition() Get the "traps-destination" property definition.

Methods inherited from class org.opends.server.admin.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static SNMPConnectionHandlerCfgDefn getInstance()

Get the SNMP Connection Handler configuration definition singleton.

Returns:

Returns the SNMP Connection Handler configuration definition singleton.

createClientConfiguration

public SNMPConnectionHandlerCfgClient createClientConfiguration(ManagedObject<? extends SNMPConnectionHandlerCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<SNMPConnectionHandlerCfgClient,SNMPConnectionHandlerCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public SNMPConnectionHandlerCfg createServerConfiguration(ServerManagedObject<? extends SNMPConnectionHandlerCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SNMPConnectionHandlerCfgClient,SNMPConnectionHandlerCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<SNMPConnectionHandlerCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SNMPConnectionHandlerCfgClient,SNMPConnectionHandlerCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getAllowedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getAllowedClientPropertyDefinition()

Get the "allowed-client" property definition.

Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this SNMP Connection Handler.

Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask.

Returns:

Returns the "allowed-client" property definition.

getAllowedManagerPropertyDefinition

public StringPropertyDefinition getAllowedManagerPropertyDefinition()

Get the "allowed-manager" property definition.

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.

Returns:

Returns the "allowed-manager" property definition.

getAllowedUserPropertyDefinition

public StringPropertyDefinition getAllowedUserPropertyDefinition()

Get the "allowed-user" property definition.

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.

Returns:

Returns the "allowed-user" property definition.

getCommunityPropertyDefinition

public StringPropertyDefinition getCommunityPropertyDefinition()

Get the "community" property definition.

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 "community" property definition.

getDeniedClientPropertyDefinition

public IPAddressMaskPropertyDefinition getDeniedClientPropertyDefinition()

Get the "denied-client" property definition.

Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this SNMP Connection Handler.

Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. If both allowed and denied client masks are defined and a client connection matches one or more masks in both lists, then the connection is denied. If only a denied list is specified, then any client not matching a mask in that list is allowed.

Returns:

Returns the "denied-client" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the SNMP Connection Handler is enabled.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getListenAddressPropertyDefinition

public IPAddressPropertyDefinition getListenAddressPropertyDefinition()

Get the "listen-address" property definition.

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.

Returns:

Returns the "listen-address" property definition.

getListenPortPropertyDefinition

public IntegerPropertyDefinition getListenPortPropertyDefinition()

Get the "listen-port" property definition.

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 "listen-port" property definition.

getOpendmkJarfilePropertyDefinition

public StringPropertyDefinition getOpendmkJarfilePropertyDefinition()

Get the "opendmk-jarfile" property definition.

Indicates the OpenDMK runtime jar file location

Returns:

Returns the "opendmk-jarfile" property definition.

getRegisteredMbeanPropertyDefinition

public BooleanPropertyDefinition getRegisteredMbeanPropertyDefinition()

Get the "registered-mbean" property definition.

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 "registered-mbean" property definition.

getSecurityAgentFilePropertyDefinition

public StringPropertyDefinition getSecurityAgentFilePropertyDefinition()

Get the "security-agent-file" property definition.

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

Returns:

Returns the "security-agent-file" property definition.

getSecurityLevelPropertyDefinition

public EnumPropertyDefinition<SNMPConnectionHandlerCfgDefn.SecurityLevel> getSecurityLevelPropertyDefinition()

Get the "security-level" property definition.

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.

Returns:

Returns the "security-level" property definition.

getTrapPortPropertyDefinition

public IntegerPropertyDefinition getTrapPortPropertyDefinition()

Get the "trap-port" property definition.

Specifies the port to use to send SNMP Traps.

Returns:

Returns the "trap-port" property definition.

getTrapsCommunityPropertyDefinition

public StringPropertyDefinition getTrapsCommunityPropertyDefinition()

Get the "traps-community" property definition.

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.

Returns:

Returns the "traps-community" property definition.

getTrapsDestinationPropertyDefinition

public StringPropertyDefinition getTrapsDestinationPropertyDefinition()

Get the "traps-destination" property definition.

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 the "traps-destination" property definition.