Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06

weblogic.management.configuration
Interface SNMPLogFilterMBean

All Superinterfaces:
ConfigurationMBean, SNMPTrapSourceMBean

public interface SNMPLogFilterMBean
extends SNMPTrapSourceMBean

This MBean represents a filter to qualify log messages which are logged to the server logfile. A message must qualify criteria specified as a filter in order to generate a notification. Multiple instances of this MBean can be defined, if needed. If there are multiple instances, a message must qualify atleast one filter to qualify for the server logfile.

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.

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 addMessageId(String messageid)
          Adds a feature to the MessageId attribute of the SNMPLogFilterMBean object
 boolean addSubsystemName(String subsystem)
          Adds a feature to the SubsystemName attribute of the SNMPLogFilterMBean object
 boolean addUserId(String userid)
          Adds a feature to the UserId attribute of the SNMPLogFilterMBean object
 String[] getMessageIds()
          A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.
 String getMessageSubstring()
          A string that is searched for in the message text.
 String getSeverityLevel()
          The minimum severity of a message that causes a WebLogic Server SNMP agent to generate a notification.
 String[] getSubsystemNames()
          A list of subsystems whose messages are selected by this log filter.
 String[] getUserIds()
          A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.
 boolean removeMessageId(String messageid)
           
 boolean removeSubsystemName(String subsystem)
           
 boolean removeUserId(String userid)
           
 void setMessageIds(String[] messageIdList)
          Sets the value of the MessageIds attribute.
 void setMessageSubstring(String MessageSubString)
          Sets the value of the MessageSubstring attribute.
 void setSeverityLevel(String severityLevel)
          Sets the value of the SeverityLevel attribute.
 void setSubsystemNames(String[] subsystemList)
          Sets the value of the SubsystemNames attribute.
 void setUserIds(String[] userIdList)
          Sets the value of the UserIds attribute.
 
Methods inherited from interface weblogic.management.configuration.SNMPTrapSourceMBean
addEnabledServer, getEnabledServers, removeEnabledServer, setEnabledServers
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 

Method Detail

getSeverityLevel

String getSeverityLevel()

The minimum severity of a message that causes a WebLogic Server SNMP agent to generate a notification.

Returns:
The severityLevel value
Default Value:
weblogic.logging.Severities.NOTICE_TEXT

setSeverityLevel

void setSeverityLevel(String severityLevel)

Sets the value of the SeverityLevel attribute.

Parameters:
severityLevel - The new severityLevel value
See Also:
SNMPLogFilterMBean.getSeverityLevel()

getSubsystemNames

String[] getSubsystemNames()

A list of subsystems whose messages are selected by this log filter. If none are specified, messages from all subsystems are selected.

Returns:
The subsystemNames value

setSubsystemNames

void setSubsystemNames(String[] subsystemList)

Sets the value of the SubsystemNames attribute.

Parameters:
subsystemList - The new subsystemNames value
See Also:
SNMPLogFilterMBean.getSubsystemNames()

addSubsystemName

boolean addSubsystemName(String subsystem)
                         throws InvalidAttributeValueException,
                                ConfigurationException

Adds a feature to the SubsystemName attribute of the SNMPLogFilterMBean object

Parameters:
subsystem - The feature to be added to the SubsystemName attribute
Returns:
Throws:
InvalidAttributeValueException
ConfigurationException

removeSubsystemName

boolean removeSubsystemName(String subsystem)
                            throws InvalidAttributeValueException,
                                   ConfigurationException
Parameters:
subsystem -
Returns:
Throws:
InvalidAttributeValueException
ConfigurationException

getUserIds

String[] getUserIds()

A list of user IDs that causes a WebLogic Server SNMP agent to generate a notification.

Every message includes the user ID from the security context in which the message was generated.

If the user ID field for a message matches one of the user IDs you specify in the filter, WebLogic Server generates a notification.

If this log filter doesn't specify user IDs, WebLogic Server can generate a notification for messages from all user IDs.

Returns:
The userIds value

setUserIds

void setUserIds(String[] userIdList)

Sets the value of the UserIds attribute.

Parameters:
userIdList - The new userIds value
See Also:
SNMPLogFilterMBean.getUserIds()

addUserId

boolean addUserId(String userid)
                  throws InvalidAttributeValueException,
                         ConfigurationException

Adds a feature to the UserId attribute of the SNMPLogFilterMBean object

Parameters:
userid - The feature to be added to the UserId attribute
Returns:
Throws:
InvalidAttributeValueException
ConfigurationException

removeUserId

boolean removeUserId(String userid)
                     throws InvalidAttributeValueException,
                            ConfigurationException
Parameters:
userid -
Returns:
Throws:
InvalidAttributeValueException
ConfigurationException

getMessageIds

String[] getMessageIds()

A list of message IDs or ID ranges that cause a WebLogic Server SNMP agent to generate a notification.

If no IDs are specified, this filter selects all message IDs.

Example list: 20,50-100,300

Returns:
The messageIds value

setMessageIds

void setMessageIds(String[] messageIdList)

Sets the value of the MessageIds attribute.

Parameters:
messageIdList - The new messageIds value
See Also:
SNMPLogFilterMBean.getMessageIds()

addMessageId

boolean addMessageId(String messageid)
                     throws InvalidAttributeValueException,
                            ConfigurationException

Adds a feature to the MessageId attribute of the SNMPLogFilterMBean object

Parameters:
messageid - The feature to be added to the MessageId attribute
Returns:
Throws:
InvalidAttributeValueException
ConfigurationException

removeMessageId

boolean removeMessageId(String messageid)
                        throws InvalidAttributeValueException,
                               ConfigurationException
Parameters:
messageid -
Returns:
Throws:
InvalidAttributeValueException
ConfigurationException

getMessageSubstring

String getMessageSubstring()

A string that is searched for in the message text. Only messages that contain the string are selected. If a string is not specified, all messages are selected.

Returns:
The messageSubstring value

setMessageSubstring

void setMessageSubstring(String MessageSubString)
                         throws InvalidAttributeValueException,
                                ConfigurationException

Sets the value of the MessageSubstring attribute.

Parameters:
MessageSubString - The new messageSubstring value
Throws:
InvalidAttributeValueException
ConfigurationException
See Also:
SNMPLogFilterMBean.getMessageSubstring()

Copyright 1996, 2011, 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
Oracle WebLogic Server MBean Javadoc
11g Release 1 (10.3.6)

Part Number E13945-06