SNMPLogFilterMBean


Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

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 trap. 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.

Fully Qualified Interface Name

If you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.SNMPLogFilterMBean

Factory Methods


Child MBeans

This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


    EnabledServers

    The list of target servers for trap generation. If no server is specified, no trap will be generated.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read/Write
    TypeServerMBean[]


    Attributes

    This section describes the following attributes:


    MessageIds

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

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

    Example list: 20,50-100,300

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    MessageSubstring

    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.

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Name

    The user-specified name of this MBean instance.

    This name is included as one of the key properties in the MBean's javax.management.ObjectName:
    Name=user-specified-name

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Notes

    Optional information that you can include to describe this configuration.

    WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

    Note:

    If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

           
    Privileges Read/Write
    Typejava.lang.String

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    SeverityLevel

    The minimum severity of a message that causes WebLogic Server to generate a trap.

    For more information, see:

           
    Privileges Read/Write
    Typejava.lang.String
    Default ValueWarning
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    SubsystemNames

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

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    UserIds

    A list of user IDs that causes WebLogic Server to generate a trap.

    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 trap.

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

           
    Privileges Read/Write
    Typeclass java.lang.String[]
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


    Operations

    This section describes the following operations:


    addEnabledServer

    Adds a feature to the EnabledServer attribute of the SNMPTrapSourceMBean object

       
    Operation Name"addEnabledServer"
    ParametersObject [] {  server }

    where:

    • server is an object of type weblogic.management.configuration.ServerMBean that specifies:

      The feature to be added to the EnabledServer attribute

    SignatureString [] { "weblogic.management.configuration.ServerMBean" }
    Returns boolean

    Exceptions

    addMessageId

    Adds a feature to the MessageId attribute of the SNMPLogFilterMBean object

       
    Operation Name"addMessageId"
    ParametersObject [] {  messageid }

    where:

    • messageid is an object of type java.lang.String that specifies:

      The feature to be added to the MessageId attribute

    SignatureString [] { "java.lang.String" }
    Returns boolean

    Exceptions

    addSubsystemName

    Adds a feature to the SubsystemName attribute of the SNMPLogFilterMBean object

       
    Operation Name"addSubsystemName"
    ParametersObject [] {  subsystem }

    where:

    • subsystem is an object of type java.lang.String that specifies:

      The feature to be added to the SubsystemName attribute

    SignatureString [] { "java.lang.String" }
    Returns boolean

    Exceptions

    addUserId

    Adds a feature to the UserId attribute of the SNMPLogFilterMBean object

       
    Operation Name"addUserId"
    ParametersObject [] {  userid }

    where:

    • userid is an object of type java.lang.String that specifies:

      The feature to be added to the UserId attribute

    SignatureString [] { "java.lang.String" }
    Returns boolean

    Exceptions

    freezeCurrentValue

    If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

    Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

    Note:

    To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

    This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

    Deprecated. 9.0.0.0

       
    Operation Name"freezeCurrentValue"
    ParametersObject [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void

    Exceptions

    isSet

    Returns true if the specified attribute has been set explicitly in this MBean instance.

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check

    SignatureString [] { "java.lang.String" }
    Returns boolean

    removeEnabledServer

       
    Operation Name"removeEnabledServer"
    ParametersObject [] {  server }

    where:

    • server is an object of type weblogic.management.configuration.ServerMBean that specifies:

      server

    SignatureString [] { "weblogic.management.configuration.ServerMBean" }
    Returns boolean

    Exceptions

    removeMessageId

       
    Operation Name"removeMessageId"
    ParametersObject [] {  messageid }

    where:

    • messageid is an object of type java.lang.String that specifies:

      messageid

    SignatureString [] { "java.lang.String" }
    Returns boolean

    Exceptions

    removeSubsystemName

       
    Operation Name"removeSubsystemName"
    ParametersObject [] {  subsystem }

    where:

    • subsystem is an object of type java.lang.String that specifies:

      subsystem

    SignatureString [] { "java.lang.String" }
    Returns boolean

    Exceptions

    removeUserId

       
    Operation Name"removeUserId"
    ParametersObject [] {  userid }

    where:

    • userid is an object of type java.lang.String that specifies:

      userid

    SignatureString [] { "java.lang.String" }
    Returns boolean

    Exceptions

    restoreDefaultValue

    If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

    Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

    This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

    Deprecated. 9.0.0.0

       
    Operation Name"restoreDefaultValue"
    ParametersObject [] {  attributeName }

    where:

    • attributeName is an object of type java.lang.String that specifies:

      attributeName

    SignatureString [] { "java.lang.String" }
    Returns void

    Exceptions

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore

    SignatureString [] { "java.lang.String" }
    Returns void