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

Part Number E41849-02

weblogic.management.configuration
Interface SNMPTrapSourceMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean
All Known Subinterfaces:
SNMPAttributeChangeMBean, SNMPCounterMonitorMBean, SNMPGaugeMonitorMBean, SNMPJMXMonitorMBean, SNMPLogFilterMBean, SNMPStringMonitorMBean

public interface SNMPTrapSourceMBean
extends ConfigurationMBean

This MBean is the base of SNMP TRAP related configuration MBeans.

Changes take effect after you redeploy the module or restart the server.

Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 boolean addEnabledServer(ServerMBean server)
          Adds a feature to the EnabledServer attribute of the SNMPTrapSourceMBean object
 ServerMBean[] getEnabledServers()
          This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain.
 boolean removeEnabledServer(ServerMBean server)
           
 void setEnabledServers(ServerMBean[] serversEnabled)
          Sets the value of the EnabledServers attribute.
 
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

getEnabledServers

ServerMBean[] getEnabledServers()

This attribute is applicable only when the SNMP Agent is running on the Admin Server of a WebLogic Domain. The EnabledServers attribute allows the users to limit the scope of the monitored data sources to the specific named Servers. The EnabledServers list is ignored when the SNMAgentDeploymentMBean is targeted to a Managed Server. In the case of a Managed Server the SNMP Agent only looks at the data available in the WebLogic Server where the SNMP Agent is deployed.

For traps based on MBean attributes the SNMP Agent refers to the Domain Runtime MBean Server when it is running on the Admin Server and the Runtime MBean Server when it is deployed to a Managed Server.

In the case of SNMPJMXMonitorMBean and SNMPAttributeChangeMBean the MonitoredMBeanType and MonitoredMBeanName attributes specify the type and name of a WebLogic Server MBean for which the trap will be setup. MBeans that meet the Type and Name criteria are qualified to set the trap on. The EnabledServers attribute allows a user to specify additional criteria based on the Location of an MBean when the SNMP Agent is targeted to the Admin Server. MBeans whose Location matches one of the Servers in the EnabledServers list are considered eligible for the trap to be generated for a corresponding JMX notification. When the EnabledServers attribute is not specified all MBeans whose Type and Name match are considered as valid sources for the SNMP trap.

In the case of SNMPLogFilterMBean the EnabledServers attribute allows a user to specify the Servers in the Domain whose log messages will be monitored when the Agent is running on the Admin Server. When EnabledServers is not specified for an Agent running on the Admin Server log messages on all Managed Servers in the domain are monitored for sending traps. This attribute is not applicable when the SNMP Agent is targeted to a Managed Server, in this case the traps are sent based on log messages generated by the respective Managed Server where the Agent is deployed.

Returns:
The enabledServers value
See Also:
SNMPJMXMonitorMBean, SNMPAttributeChangeMBean

setEnabledServers

void setEnabledServers(ServerMBean[] serversEnabled)
                       throws InvalidAttributeValueException,
                              ConfigurationException

Sets the value of the EnabledServers attribute.

Parameters:
serversEnabled - The new enabledServers value
Throws:
InvalidAttributeValueException
ConfigurationException
See Also:
SNMPTrapSourceMBean.getEnabledServers()

addEnabledServer

boolean addEnabledServer(ServerMBean server)
                         throws InvalidAttributeValueException,
                                ConfigurationException

Adds a feature to the EnabledServer attribute of the SNMPTrapSourceMBean object

Parameters:
server - The feature to be added to the EnabledServer attribute
Throws:
InvalidAttributeValueException
ConfigurationException

removeEnabledServer

boolean removeEnabledServer(ServerMBean server)
                            throws InvalidAttributeValueException,
                                   ConfigurationException
Parameters:
server -
Throws:
InvalidAttributeValueException
ConfigurationException

Copyright 1996, 2014, 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.1.3)

Part Number E41849-02