Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface SNMPJMXMonitorMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, SNMPTrapSourceMBean, WebLogicMBean
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.


Field Summary

 

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

 

Method Summary
abstract  String getMonitoredAttributeName()
          The name of an MBean attribute to monitor.
abstract  String getMonitoredMBeanName()
          The name of the MBean instance that you want to monitor.
abstract  String getMonitoredMBeanType()
          The MBean type that defines the attribute you want to monitor.
abstract  int getPollingInterval()
          The frequency (in seconds) that WebLogic Server checks the attribute value.
abstract  void setMonitoredAttributeName(String attributeName)
          Sets the value of the MonitoredAttributeName attribute.
abstract  void setMonitoredMBeanName(String mbeanname)
          Sets the value of the MonitoredMBeanName attribute.
abstract  void setMonitoredMBeanType(String mbeantype)
          Sets the value of the MonitoredMBeanType attribute.
abstract  void setPollingInterval(int interval)
          Sets the value of the PollingInterval attribute.

 

Methods inherited from interface weblogic.management.configuration.SNMPTrapSourceMBean
addEnabledServer, getEnabledServers, removeEnabledServer, setEnabledServers

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

 

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Method Detail

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

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

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

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()

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09