java.lang.Object
- org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>
- - org.forgerock.opendj.config.ManagedObjectDefinition<SnmpConnectionHandlerCfgClient,SnmpConnectionHandlerCfg>
  - - org.forgerock.opendj.server.config.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 Description

static class SnmpConnectionHandlerCfgDefn.SecurityLevel
Defines the set of permissible values for the "security-level" property.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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.
`HostPropertyDefinition`	`getListenAddressPropertyDefinition()`	Get the "listen-address" property definition.
`IntegerPropertyDefinition`	`getListenPortPropertyDefinition()`	Get the "listen-port" property definition.
`BooleanPropertyDefinition`	`getRegisteredMbeanPropertyDefinition()`	Get the "registered-mbean" property definition.
`IntegerPropertyDefinition`	`getRestrictedClientConnectionLimitPropertyDefinition()`	Get the "restricted-client-connection-limit" property definition.
`IpAddressMaskPropertyDefinition`	`getRestrictedClientPropertyDefinition()`	Get the "restricted-client" 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.forgerock.opendj.config.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)
```
    Description copied from class: ManagedObjectDefinition
    
    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)
```
    Description copied from class: ManagedObjectDefinition
    
    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()
```
    Description copied from class: ManagedObjectDefinition
    
    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.
    A set of clients who will be 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.
    
    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.
    A set of clients who 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. Specifying a value for this property in a connection handler will override any value set in the global configuration.
    
    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 HostPropertyDefinition 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.
  - 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.
  - getRestrictedClientPropertyDefinition
```
public IpAddressMaskPropertyDefinition getRestrictedClientPropertyDefinition()
```
    Get the "restricted-client" property definition.
    A set of clients who will be limited to the maximum number of connections specified by the "restricted-client-connection-limit" property.
    Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. Specifying a value for this property in a connection handler will override any value set in the global configuration.
    
    Returns:
    
    Returns the "restricted-client" property definition.
  - getRestrictedClientConnectionLimitPropertyDefinition
```
public IntegerPropertyDefinition getRestrictedClientConnectionLimitPropertyDefinition()
```
    Get the "restricted-client-connection-limit" property definition.
    Specifies the maximum number of connections a restricted client can open at the same time to this SNMP Connection Handler.
    Once Directory Server accepts the specified number of connections from a client specified in restricted-client, any additional connection will be rejected. The number of connections is maintained by IP address. Specifying a value for this property in a connection handler will override any value set in the global configuration.
    
    Returns:
    
    Returns the "restricted-client-connection-limit" 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.

Class SnmpConnectionHandlerCfgDefn

Nested Class Summary

Method Summary

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

Methods inherited from class java.lang.Object

Method Detail

getInstance

createClientConfiguration

createServerConfiguration

getServerConfigurationClass

getAllowedClientPropertyDefinition

getAllowedManagerPropertyDefinition

getAllowedUserPropertyDefinition

getCommunityPropertyDefinition

getDeniedClientPropertyDefinition

getEnabledPropertyDefinition

getJavaClassPropertyDefinition

getListenAddressPropertyDefinition

getListenPortPropertyDefinition

getRegisteredMbeanPropertyDefinition

getRestrictedClientPropertyDefinition

getRestrictedClientConnectionLimitPropertyDefinition

getSecurityAgentFilePropertyDefinition

getSecurityLevelPropertyDefinition

getTrapPortPropertyDefinition

getTrapsCommunityPropertyDefinition

getTrapsDestinationPropertyDefinition