public interface SNMPParameterSetTypeMBean
The SNMPParameterSetTypeMBean
interface provides methods to manage the SNMP mapping configurations of a single statistics parameter set type.
Modifier and Type | Method and Description |
---|---|
void |
clearCounterMapping(String counterName)
Clear a counter mapping in the parameter set type configuration managed by this MBean.
|
void |
clearOIDMapping()
Clear the OID mapping in the parameter set type configuration managed by this MBean.
|
int |
getCounterMapping(String counterName)
Get a counter mapping from the parameter set type configuration managed by this MBean.
|
TabularData |
getCounterMappings()
Get the current counter mappings in the parameter set type configuration managed by this MBean.
|
CompositeData |
getOIDMapping()
Get the current OID mapping in the parameter set type configuration managed by this MBean.
|
void |
setCounterMapping(String counterName,
int index)
Set a counter mapping in the parameter set type configuration managed by this MBean.
|
void |
setOIDMapping(String oid)
Set the OID mapping in the parameter set type configuration managed by this MBean.
|
CompositeData getOIDMapping() throws OpenDataException, ConfigurationException
Get the current OID mapping in the parameter set type configuration managed by this MBean.
The data returned is CompositeData
with the same structure as specified by SNMPParameterSetTypeManagementMBean.getAllOIDMappings()
.
OpenDataException
- if an error occurs creating the composite data.ConfigurationException
- if a configuration error occurs.void setOIDMapping(String oid) throws InvalidArgumentException, ConfigurationException
Set the OID mapping in the parameter set type configuration managed by this MBean.
The OID parameter may be either a fixed OID value or the value "auto"
, in which case an available OID will be auto-assigned to the parameter set type.
oid
- an OID, the value "auto"
.NullPointerException
- if oid
is null
.InvalidArgumentException
- if an invalid OID is specified.ConfigurationException
- if a configuration error occurs.void clearOIDMapping() throws InvalidStateException, ConfigurationException
Clear the OID mapping in the parameter set type configuration managed by this MBean.
If the parameter set type is currently in use by SNMP then it will be deregistered from the SNMP view as a result.
ConfigurationException
- if a configuration error occurs.InvalidStateException
TabularData getCounterMappings() throws OpenDataException, ConfigurationException
Get the current counter mappings in the parameter set type configuration managed by this MBean.
The data returned is TabularData
with the same structure as specified by SNMPParameterSetTypeManagementMBean.getAllCounterMappings()
.
OpenDataException
- if an error occurs creating the tabular data.ConfigurationException
- if a configuration error occurs.void setCounterMapping(String counterName, int index) throws NullPointerException, InvalidArgumentException, ConfigurationException
Set a counter mapping in the parameter set type configuration managed by this MBean.
The index parameter may be either a fixed index value equal or greater than 2, or the value 0, in which case an available mapping will be auto-assigned. The counter will be mapped to this OID suffix.
counterName
- the name of the counter.index
- a fixed OID suffix equal or greater than 2
or the value 0
.NullPointerException
- if counterName
is null
.InvalidArgumentException
- if index
is less than 0 or equal to 1.ConfigurationException
- if a configuration error occurs.void clearCounterMapping(String counterName) throws NullPointerException, InvalidArgumentException, ConfigurationException
Clear a counter mapping in the parameter set type configuration managed by this MBean. The mapping for the specified counter will be cleared.
Note that if the parameter set type configuration and counter is currently in use then a new mapping for the counter will automatically be set. The new counter mapping may or may not be the same as the previous mapping.
counterName
- the name of the counter.NullPointerException
- if counterName
is null
.InvalidArgumentException
- if a mapping for the specified counter doesn’t currently exist.ConfigurationException
- if a configuration error occurs.int getCounterMapping(String counterName) throws NullPointerException, InvalidArgumentException, ConfigurationException
Get a counter mapping from the parameter set type configuration managed by this MBean. The OID suffix mapping for the specified counter is returned.
counterName
- the name of the counter.0
if the counter is not currently mapped.NullPointerException
- if counterName
is null
.InvalidArgumentException
- if a mapping for the specified counter doesn’t currently exist.ConfigurationException
- if a configuration error occurs.