weblogic.management.configuration
Interface SNMPJMXMonitorMBean

All Superinterfaces:

ConfigurationMBean, SNMPTrapSourceMBean

All Known Subinterfaces:

SNMPCounterMonitorMBean, SNMPGaugeMonitorMBean, SNMPStringMonitorMBean

public interface SNMPJMXMonitorMBean
extends SNMPTrapSourceMBean

This is a base class for Monitor based trap configuration MBeans : SNMPCounterMonitorMBean, SNMPStringMonitorMBean and SNMPGaugeMonitorMBean.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX."

getMonitoredMBeanType

String getMonitoredMBeanType()

The MBean type that defines the attribute you want to monitor. Do not include the MBean suffix. For example, ServerRuntime.

Returns:

The monitoredMBeanType value

This method can NOT set a value of zero length.

setMonitoredMBeanType

void setMonitoredMBeanType(String mbeantype)
                           throws InvalidAttributeValueException,
                                  ConfigurationException

Sets the value of the MonitoredMBeanType attribute.

Parameters:

mbeantype - The new monitoredMBeanType value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPJMXMonitorMBean.getMonitoredMBeanType()

getMonitoredMBeanName

String getMonitoredMBeanName()

The name of the MBean instance that you want to monitor. If you leave the name undefined, WebLogic Server monitors all instances of the MBean type that you specify in Monitored MBean Type.

If you target SNMP agents to individual Managed Servers, make sure that the MBean instance you specify is active on the Managed Servers you have targeted. For example, if you specify MServer1 as the name of a ServerRuntimeMBean instance, this monitor will only function if you target an SNMP agent either to the Administration Server or to a Managed Server named MServer1.

Do not enter the full JMX object name of the MBean instance. Instead, enter only the value of the object name's Name=name name-value pair. To create unique MBean object names, WebLogic Server encodes several name-value pairs into each object name. One of these pairs is Name=name. For example:
"MedRec:Name=MedRecServer,
Type=ServerRuntime"

In the previous example, specify MedRecServer as the name of the MBean instance.

Returns:

The monitoredMBeanName value

setMonitoredMBeanName

void setMonitoredMBeanName(String mbeanname)
                           throws InvalidAttributeValueException,
                                  ConfigurationException

Sets the value of the MonitoredMBeanName attribute.

Parameters:

mbeanname - The new monitoredMBeanName value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPJMXMonitorMBean.getMonitoredMBeanName()

getMonitoredAttributeName

String getMonitoredAttributeName()

The name of an MBean attribute to monitor. This attribute must be in the WebLogic Server MIB.

Returns:

The monitoredAttributeName value

This method can NOT set a value of zero length.

setMonitoredAttributeName

void setMonitoredAttributeName(String attributeName)
                               throws InvalidAttributeValueException,
                                      ConfigurationException

Sets the value of the MonitoredAttributeName attribute.

Parameters:

attributeName - The new monitoredAttributeName value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPJMXMonitorMBean.getMonitoredAttributeName()

getPollingInterval

int getPollingInterval()

The frequency (in seconds) that WebLogic Server checks the attribute value.

Returns:

The pollingInterval value

Default Value:

10

Maximum Value:

65535

Minimum Value:

1

setPollingInterval

void setPollingInterval(int interval)
                        throws InvalidAttributeValueException,
                               ConfigurationException

Sets the value of the PollingInterval attribute.

Parameters:

interval - The new pollingInterval value

Throws:

InvalidAttributeValueException

ConfigurationException

See Also:

SNMPJMXMonitorMBean.getPollingInterval()