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
String	auditStaticOIDs(boolean includeMissingBaseOIDs)	Audit all verified components that reference a parameter set type, directly or indirectly, for missing SNMP static OID suffixes and aliases used for generating SNMP MIB definitions.
ObjectName	createParameterSetTypeConfig(String parameterSetTypeName)	Create an SNMP mapping configuration for a statistics parameter set type.
TabularData	getAllCounterMappings()	Get all current configured counter mappings.
TabularData	getAllOIDMappings()	Get all current configured parameter set type → OID mappings for configurable OID mappings.
TabularData	getAllStaticOIDCounterSuffixes()	Get OID suffixes for all counters in all parameter set types declared with static OIDs.
TabularData	getAllStaticOIDMappingsByComponent()	Get all current components and their registered static aliases and OIDs.
TabularData	getAllStaticOIDs()	Get all current static OIDs registered for parameter set types.
TabularData	getAllStaticOIDSuffixMappings()	Get all static OID suffix mappings defined by the installed OID Suffix Mapping Descriptors.
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.
TabularData	getStaticOIDSuffixMappings(OIDSuffixMappingDescriptorID descriptor)	Get the static OID suffix mappings defined by the specified OID Suffix Mapping Descriptor.
ObjectName	getStaticParameterSetType(String parameterSetTypeName)	Get the ObjectName of a SNMPParameterSetTypeMBean that can be used to view OID information for the specified statistics parameter set type.
String[]	getStaticParameterSetTypes()	Get the names of all parameter set types that are using Rhino 3.1+ static OID registration behaviour.
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. This method can only be used for parameter set types that are using the legacy OID registration behaviour where OID mappings are stored in runtime-changeable configuration.

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. This method only returns names for parameter set types that are using the legacy OID registration behaviour where OID mappings are stored in runtime-changeable configuration.

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 configured parameter set type → OID mappings for configurable OID mappings. This method only returns mappings for OIDs using the legacy OID registration behaviour where mappings are stored in runtime-changeable configuration.

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.

See Also:

SNMPManagementMBean.getLegacyOIDsEnabled()

getStaticParameterSetType

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

Get the ObjectName of a SNMPParameterSetTypeMBean that can be used to view OID information for the specified statistics parameter set type. This method can only be used for parameter set types that are using the Rhino 3.1+ static OID registration behaviour.

The MBean referenced by the ObjectName returned from this method provides a read-only view of the OID information of that parameter set type. Any attempt to use the mutator operations of the MBean will result in a ConfigurationException being thrown.

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 parameter set type with the specified name doesn’t exist or doesn’t use statically declared OIDs.

ConfigurationException - if an error occurs obtaining the ObjectName.

Since:

Rhino 3.1.0

getStaticParameterSetTypes

String[] getStaticParameterSetTypes()

Get the names of all parameter set types that are using Rhino 3.1+ static OID registration behaviour.

Returns:

the parameter set type names.

Since:

Rhino 3.1.0.

getAllStaticOIDs

TabularData getAllStaticOIDs()
                      throws OpenDataException

Get all current static OIDs registered for parameter set types. This method only returns results for OIDs defined using the Rhino 3.1+ static OID registration behaviour.

This method returns results from 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 parameter set type 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 determined for the parameter set type. The value "-- cleared --" indicates that the parameter set type does not have a complete static OID.
in-use	SimpleType.STRING	A flag indicating whether the OID is actively being use within Rhino.

The structure of the result data is compatible with the output of getAllOIDMappings().

Returns:

tabular data as described above.

Throws:

OpenDataException - if an error occurs creating the tabular data.

Since:

Rhino 3.1.0

See Also:

SNMPManagementMBean.getStaticOIDsEnabled()

getAllCounterMappings

TabularData getAllCounterMappings()
                           throws OpenDataException,
                                  ConfigurationException

Get all current configured 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.

getAllStaticOIDCounterSuffixes

TabularData getAllStaticOIDCounterSuffixes()
                                    throws OpenDataException

Get OID suffixes for all counters in all parameter set types declared with static OIDs. This method only returns results for parameter set types with OIDs defined using the Rhino 3.1+ static OID registration behaviour.

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 parameter set type counter 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 OID suffix the parameter set type counter has been assigned. This value will be -1 if the counter has not been statically assigned an OID suffix.

Returns:

tabular data as described above.

Throws:

OpenDataException - if an error occurs creating the tabular data.

Since:

Rhino 3.1.0

getStaticOIDSuffixMappings

TabularData getStaticOIDSuffixMappings(OIDSuffixMappingDescriptorID descriptor)
                                throws NullPointerException,
                                       UnsupportedOperationException,
                                       UnrecognizedComponentException,
                                       OpenDataException

Get the static OID suffix mappings defined by the specified OID Suffix Mapping Descriptor.

This operation can only be invoked on an SNMPParameterSetTypeManagementMBean instance associated with a specific namespace, ie. the getSNMPParameterSetTypeManagementMBean(java.lang.String) must have been used to obtain the ObjectName of an MBean instance for the relevant namespace.

The data returned is TabularData with the same structure as described by the getAllStaticOIDSuffixMappings() operation.

Parameters:

descriptor - the component identifier of the OID Suffix Mapping Descriptor.

Returns:

tabular data as described above.

Throws:

NullPointerException - if descriptor is null.

UnsupportedOperationException - if this method is invoked on the "default" SNMPParameterSetTypeManagementMBean that is not associated with any namespace.

UnrecognizedComponentException - if descriptor is not a recognisable OIDSuffixMappingDescriptorID object for the SLEE or it does not correspond with an OID Suffix Mapping Descriptor installed in the SLEE.

OpenDataException - if an error occurs creating the tabular data.

Since:

Rhino 3.1.0

getAllStaticOIDSuffixMappings

TabularData getAllStaticOIDSuffixMappings()
                                   throws UnsupportedOperationException,
                                          OpenDataException

Get all static OID suffix mappings defined by the installed OID Suffix Mapping Descriptors.

This operation can only be invoked on an SNMPParameterSetTypeManagementMBean instance associated with a specific namespace, ie. the getSNMPParameterSetTypeManagementMBean(java.lang.String) must have been used to obtain the ObjectName of an MBean instance for the relevant namespace.

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	SimpleType.STRING	The type of the mapping, either profile-table or resource-adaptor-entity.
name	SimpleType.STRING	The name of the profile table or resource adaptor entity the mapping applies to.
oid-suffix	SimpleType.STRING	The OID suffix that the name has been mapped to.
components	String[][]	An array of String[3] containing the name, vendor, and version in each element respectively of each OID Suffix Mapping Descriptor component identifier that has defined the mapping.

Returns:

tabular data as described above.

Throws:

UnsupportedOperationException - if this method is invoked on the "default" SNMPParameterSetTypeManagementMBean that is not associated with any namespace.

OpenDataException - if an error occurs creating the tabular data.

Since:

Rhino 3.1.0

auditStaticOIDs

String auditStaticOIDs(boolean includeMissingBaseOIDs)
                throws OpenDataException

Audit all verified components that reference a parameter set type, directly or indirectly, for missing SNMP static OID suffixes and aliases used for generating SNMP MIB definitions.

For the default mode:

All resource adaptors and profile specifications that have a statically assigned base OID and reference a parameter set type are audited. A resource adaptor or profile specification fails an audit if:

• that component does not have a statistics presentation alias assigned to it, or

• that component’s instantiated resource adaptor entity or profile table does not have an OID suffix assigned to it.

All services that have a statically assigned base OID and a constituent SBB that references a parameter set type are audited. A service fails an audit if that service does not have a statistics presentation alias assigned to it.

All SBBs that reference a parameter set type and have a parent service component that has a statically assigned base OID are audited. An SBB fails an audit if that SBB:

• does not have a statistics presentation alias assigned to it, or

• does not have an OID suffix assigned to it.

All parameter set types that are referenced by components that are included in the audit fail the audit if:

• the parameter set type does not have an OID suffix assigned to it, or

• the parameter set type does not have a statistics presentation alias assigned to it, or

• a counter referenced by the parameter set type does not have an OID suffix assigned to it.

For the 'includeMissingBaseOIDs' mode:

If the option flag includeMissingBaseOIDs is true, then all com.opencloud.rhino.management.deployment.InstallLevel.VERIFIED components that reference a parameter set type are audited. A verified service is included in the audit if it contains an SBB that references a parameter set type. The parent components do not require a statically assigned base OID to be included in the audit.

As well as performing the standard audit checks, this mode also includes a check for the assigned base OID.

Parameters:

includeMissingBaseOIDs - option includes verified components missing base OIDs in the audit of verified components.

Returns:

JSON-formatted string reporting the result of the audit and what components have failed it.

Throws:

OpenDataException - if an error occurs creating the JSON data.

Since:

Rhino 3.1.0

getAllStaticOIDMappingsByComponent

TabularData getAllStaticOIDMappingsByComponent()
                                        throws OpenDataException

Get all current components and their registered static aliases and OIDs.

This method returns results from 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 component resides in. A null value for this field indicates a component is in the global environment. An empty string denotes a component is in the default namespace. Any other value indicates a component is in the specified user-defined namespace
component-id	CompositeData	The identity of the component for which the row is relevant. This is stored as a Component ID CompositeData object (see below)
oid	SimpleType.STRING	The base OID or OID suffix specified for the component. The value null indicates that the component does not have a static OID set.
alias	SimpleType.STRING	The alias specified for the component. The value null indicates that the component does not have an alias set.

Component ID

A CompositeData object that contains the data to form a object that is a derivative of ComponentID.

[cols="<,<,<",options="header",]

Column name

JMX type

Description

type

SimpleType.STRING

This is the name of the class of the Component ID. This class extends the javax.slee.ComponentID class.

name

SimpleType.STRING

Name of the component.

vendor

SimpleType.STRING

Vendor of the component.

version

SimpleType.STRING

Version of the component.

Returns:

tabular data as described above.

Throws:

OpenDataException - if an error occurs creating the tabular data.

Since:

Rhino 3.1.0