Package com.opencloud.rhino.snmp

Interface SNMPParameterSetTypeManagementMBean

public interface SNMPParameterSetTypeManagementMBean

The SNMPParameterSetTypeManagementMBean interface provides methods to create and manage statistics parameter set type SNMP mapping configurations in Rhino.

The "default" SNMPParameterSetTypeManagementMBean instance manages SNMP parameter set types for the global environment. To manage SNMP parameter set types for a specific namespace, use the getSNMPParameterSetTypeManagementMBean(String) method to get the ObjectName of an MBean instance that will do so.

Field Summary

Fields

Modifier and Type	Field	Description
static String	MBEAN_NAME	The name of this MBean, equal to the string "SNMPParameterSetType".
static String	NAMESPACE_KEY	The JMX Object Name property key that identifies the namespace that the SNMP Parameter Set Type Management MBean is managing state for.
static String	OBJECT_NAME	The JMX Object Name of this MBean.

Method Summary

Modifier and Type	Method	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.
ObjectName	getSNMPParameterSetTypeManagementMBean(String namespace)	Get the ObjectName of a SNMPParameterSetTypeManagementMBean that can be used to manage the SNMP parameter set type configuration items for a namespace.
void	removeParameterSetTypeConfig(String parameterSetTypeName)	Remove an SNMP mapping configuration for a statistics parameter set type.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

The name of this MBean, equal to the string "SNMPParameterSetType".

See Also:

Constant Field Values

OBJECT_NAME

static final String OBJECT_NAME

The JMX Object Name of this MBean.

NAMESPACE_KEY

static final String NAMESPACE_KEY

The JMX Object Name property key that identifies the namespace that the SNMP Parameter Set Type Management MBean is managing state for. This key is equal to the string "namespace". This key is only present present in the Object Name if the MBean is providing namespace-specific configuration rather than global configuration. The value of this key, if present, is the quoted name of the namespace.

Since:

Rhino 2.6.0

See Also:

Constant Field Values

Method Detail

getSNMPParameterSetTypeManagementMBean

ObjectName getSNMPParameterSetTypeManagementMBean(String namespace)
                                           throws UnrecognizedNamespaceException,
                                                  ManagementException

Get the ObjectName of a SNMPParameterSetTypeManagementMBean that can be used to manage the SNMP parameter set type configuration items for a namespace.

Parameters:

namespace - the name of the namespace. A null value or an empty string can be used to denote the default namespace.

Returns:

The object name of a SNMPParameterSetTypeManagementMBean for the specified namespace.

Throws:

UnrecognizedNamespaceException - if name is a non-zero-length string and is not a recognised user-defined namespace name.

ConfigurationException - if a configuration error occurs.

ManagementException

Since:

Rhino 2.6.0

createParameterSetTypeConfig

ObjectName createParameterSetTypeConfig(String parameterSetTypeName)
                                 throws NullPointerException,
                                        InvalidArgumentException,
                                        ConfigurationException

Create an SNMP mapping configuration for a statistics parameter set type.

Parameters:

parameterSetTypeName - the name of the parameter set type to create the mapping for.

Returns:

The object name of a SNMPParameterSetTypeMBean that can be used to manage the new configuration.

Throws:

NullPointerException - if parameterSetTypeName is null.

InvalidArgumentException - if a configuration for the specified parameter set type already exists.

ConfigurationException - if a configuration error occurs.

getParameterSetTypeConfig

ObjectName getParameterSetTypeConfig(String parameterSetTypeName)
                              throws NullPointerException,
                                     InvalidArgumentException,
                                     ConfigurationException

Get the ObjectName of a SNMPParameterSetTypeMBean that can be used to manage the SNMP mapping configuration for a statistics parameter set type.

Parameters:

parameterSetTypeName - the name of the parameter set type to return the MBean for.

Returns:

The object name of a SNMPParameterSetTypeMBean.

Throws:

NullPointerException - if parameterSetTypeName is null.

InvalidArgumentException - if a configuration for the specified parameter set type doesn’t exist.

ConfigurationException - if a configuration error occurs.

getParameterSetTypeConfigs

String[] getParameterSetTypeConfigs()
                             throws ConfigurationException

Get the names of all parameter set types that have configured SNMP mappings.

Returns:

the parameter set type names.

Throws:

ConfigurationException - if a configuration error occurs.

removeParameterSetTypeConfig

void removeParameterSetTypeConfig(String parameterSetTypeName)
                           throws NullPointerException,
                                  InvalidArgumentException,
                                  ConfigurationException

Remove an SNMP mapping configuration for a statistics parameter set type.

Parameters:

parameterSetTypeName - the name of the parameter set type to remove the configuration of.

Throws:

NullPointerException - if parameterSetTypeName is null.

InvalidArgumentException - if a configuration for the specified parameter set type doesn’t exist.

ConfigurationException - if a configuration error occurs.

getAllOIDMappings

TabularData getAllOIDMappings()
                       throws OpenDataException,
                              ConfigurationException

Get all current parameter set type → OID mappings. This method returns mappings for all namespaces.

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.
namespace	SimpleType.STRING	The namespace that the mapping resides in. A null value for this field indicates a parameter set type in the global environment. An empty string denotes a parameter set type in the default namespace. Any other value indicates a parameter set type in the specified user-defined namespace
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.

Returns:

tabular data as described above.

Throws:

OpenDataException - if an error occurs creating the tabular data.

ConfigurationException - if a configuration error occurs.

getAllCounterMappings

TabularData getAllCounterMappings()
                           throws OpenDataException,
                                  ConfigurationException

Get all current counter mappings.

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.
namespace	SimpleType.STRING	The namespace that the mapping resides in. A null value for this field indicates a parameter set type in the global environment. An empty string denotes a parameter set type in the default namespace. Any other value indicates a parameter set type in the specified user-defined namespace
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.

Returns:

tabular data as described above.

Throws:

OpenDataException - if an error occurs creating the tabular data.

ConfigurationException - if a configuration error occurs.