public interface SNMPParameterSetTypeManagementMBean
SNMPParameterSetTypeManagementMBean
interface provides methods to create
and manage statistics parameter set type SNMP mapping configurations in Rhino.Modifier and Type | Field and Description |
---|---|
static String |
MBEAN_NAME
The name of this MBean, equal to the string "SNMPParameterSetType".
|
static String |
OBJECT_NAME
The JMX Object Name of this MBean.
|
Modifier and Type | Method and Description |
---|---|
ObjectName |
createParameterSetTypeConfig(String parameterSetTypeName)
Create an SNMP mapping configuration for a statistics parameter set type.
|
TabularData |
getAllCounterMappings()
Get all current counter mappings.
|
TabularData |
getAllOIDMappings()
Get all current parameter set type -> OID mappings.
|
ObjectName |
getParameterSetTypeConfig(String parameterSetTypeName)
Get the ObjectName of a
SNMPParameterSetTypeMBean that can be used to manage the SNMP
mapping configuration for a statistics parameter set type. |
String[] |
getParameterSetTypeConfigs()
Get the names of all parameter set types that have configured SNMP mappings.
|
void |
removeParameterSetTypeConfig(String parameterSetTypeName)
Remove an SNMP mapping configuration for a statistics parameter set type.
|
static final String MBEAN_NAME
static final String OBJECT_NAME
ObjectName createParameterSetTypeConfig(String parameterSetTypeName) throws NullPointerException, InvalidArgumentException, ConfigurationException
parameterSetTypeName
- the name of the parameter set type to create the mapping for.SNMPParameterSetTypeMBean
that can be used to manage
the new configuration.NullPointerException
- if parameterSetTypeName
is null
.InvalidArgumentException
- if a configuration for the specified parameter set type already exists.ConfigurationException
- if a configuration error occurs.ObjectName getParameterSetTypeConfig(String parameterSetTypeName) throws NullPointerException, InvalidArgumentException, ConfigurationException
SNMPParameterSetTypeMBean
that can be used to manage the SNMP
mapping configuration for a statistics parameter set type.parameterSetTypeName
- the name of the parameter set type to return the MBean for.SNMPParameterSetTypeMBean
.NullPointerException
- if parameterSetTypeName
is null
.InvalidArgumentException
- if a configuration for the specified parameter set type doesn't exist.ConfigurationException
- if a configuration error occurs.String[] getParameterSetTypeConfigs() throws ConfigurationException
ConfigurationException
- if a configuration error occurs.void removeParameterSetTypeConfig(String parameterSetTypeName) throws NullPointerException, InvalidArgumentException, ConfigurationException
parameterSetTypeName
- the name of the parameter set type to remove the configuration of.NullPointerException
- if parameterSetTypeName
is null
.InvalidArgumentException
- if a configuration for the specified parameter set type doesn't exist.ConfigurationException
- if a configuration error occurs.TabularData getAllOIDMappings() throws OpenDataException, ConfigurationException
The data returned is TabularData
with the following items in each CompositeData
element:
Column name | JMX type | Description |
---|---|---|
index | SimpleType.INTEGER |
The index of the table row. This is a sequence counter that is unique for each row. |
type-name | SimpleType.STRING |
The name of the parameter set type for which the row is relevant. |
oid | SimpleType.STRING |
The OID the parameter set type is mapped to. |
in-use | SimpleType.STRING |
A flag indicating whether the configuration is actively being use. |
OpenDataException
- if an error occurs creating the tabular data.ConfigurationException
- if a configuration error occurs.TabularData getAllCounterMappings() throws OpenDataException, ConfigurationException
The data returned is TabularData
with the following items in each CompositeData
element:
Column name | JMX type | Description |
---|---|---|
index | SimpleType.INTEGER |
The index of the table row. This is a sequence counter that is unique for each row. |
type-name | SimpleType.STRING |
The name of the parameter set type for which the row is relevant. |
counter-name | SimpleType.STRING |
The name of the counter for which the row is relevant. |
mapping | SimpleType.INTEGER |
The last digit of the OID the parameter set type counter is mapped to. This value will be -1 if the counter mapping has been cleared, and 0 if the counter mapping is set to auto-configure. |
OpenDataException
- if an error occurs creating the tabular data.ConfigurationException
- if a configuration error occurs.