|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SNMPConnectionHandlerCfgClient
A client-side interface for reading and modifying 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 | |
---|---|
ManagedObjectDefinition<? extends SNMPConnectionHandlerCfgClient,? extends SNMPConnectionHandlerCfg> |
definition()
Get the configuration definition 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. |
java.lang.Integer |
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. |
java.lang.Integer |
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 |
setAllowedManager(java.util.Collection<java.lang.String> values)
Sets the "allowed-manager" property. |
void |
setAllowedUser(java.util.Collection<java.lang.String> values)
Sets the "allowed-user" property. |
void |
setCommunity(java.lang.String value)
Sets the "community" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setListenPort(int value)
Sets the "listen-port" property. |
void |
setOpendmkJarfile(java.lang.String value)
Sets the "opendmk-jarfile" property. |
void |
setRegisteredMbean(java.lang.Boolean value)
Sets the "registered-mbean" property. |
void |
setSecurityAgentFile(java.lang.String value)
Sets the "security-agent-file" property. |
void |
setSecurityLevel(SNMPConnectionHandlerCfgDefn.SecurityLevel value)
Sets the "security-level" property. |
void |
setTrapPort(int value)
Sets the "trap-port" property. |
void |
setTrapsCommunity(java.lang.String value)
Sets the "traps-community" property. |
void |
setTrapsDestination(java.util.Collection<java.lang.String> values)
Sets the "traps-destination" property. |
Methods inherited from interface org.opends.server.admin.std.client.ConnectionHandlerCfgClient |
---|
getAllowedClient, getDeniedClient, isEnabled, setAllowedClient, setDeniedClient, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends SNMPConnectionHandlerCfgClient,? extends SNMPConnectionHandlerCfg> definition()
definition
in interface ConfigurationClient
definition
in interface ConnectionHandlerCfgClient
java.util.SortedSet<java.lang.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 asterik (*) opens access to all managers.
void setAllowedManager(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
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.
values
- The values of the "allowed-manager" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.util.SortedSet<java.lang.String> getAllowedUser()
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.
void setAllowedUser(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
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.
values
- The values of the "allowed-user" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.lang.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.
void setCommunity(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "community" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
getJavaClass
in interface ConnectionHandlerCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the SNMP Connection Handler implementation.
setJavaClass
in interface ConnectionHandlerCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.Integer 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.
void setListenPort(int value) throws IllegalPropertyValueException
Specifies the port number on which the SNMP Connection Handler will listen for connections from clients.
Only a single port number may be provided.
value
- The value of the "listen-port" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getOpendmkJarfile()
Indicates the OpenDMK runtime jar file location
void setOpendmkJarfile(java.lang.String value) throws IllegalPropertyValueException
Indicates the OpenDMK runtime jar file location
value
- The value of the "opendmk-jarfile" property.
IllegalPropertyValueException
- If the new value is invalid.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.
void setRegisteredMbean(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "registered-mbean" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getSecurityAgentFile()
Specifies the USM security configuration to receive authenticated only SNMP requests.
void setSecurityAgentFile(java.lang.String value) throws IllegalPropertyValueException
Specifies the USM security configuration to receive authenticated only SNMP requests.
value
- The value of the "security-agent-file" property.
IllegalPropertyValueException
- If the new value is invalid.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 id required for SNMP V3 security configuration.
void setSecurityLevel(SNMPConnectionHandlerCfgDefn.SecurityLevel value) throws IllegalPropertyValueException
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.
value
- The value of the "security-level" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.Integer getTrapPort()
Specifies the port to use to send SNMP Traps.
void setTrapPort(int value) throws IllegalPropertyValueException
Specifies the port to use to send SNMP Traps.
value
- The value of the "trap-port" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getTrapsCommunity()
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.
void setTrapsCommunity(java.lang.String value) throws IllegalPropertyValueException
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.
value
- The value of the "traps-community" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.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.
void setTrapsDestination(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
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.
values
- The values of the "traps-destination" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |