DefaultAuditorMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents configuration information for the WebLogic Auditing provider.

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.

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.security.providers.audit.DefaultAuditorMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from AuditorMBean Because this MBean extends or implements AuditorMBean, you can also access this MBean by retrieving AuditorMBeans. The following attributes contain AuditorMBeans and its subtypes:


    Related MBeans

    This section describes attributes that provide access to other MBeans.


      Realm

      Returns the realm that contains this security provider. Returns null if this security provider is not contained by a realm.

             
      Privileges Read only
      TypeRealmMBean
      Relationship type: Reference.


      Attributes

      This section describes the following attributes:


      ActiveContextHandlerEntries

      Returns the ContextHandler entries that the Audit provider is currently configured to process.

             
      Privileges Read/Write
      Typeclass java.lang.String[]

      BeginMarker

      The marker that indicates the beginning of the audit record.

             
      Privileges Read/Write
      Typejava.lang.String
      Default Value#### Audit Record Begin

      Description

      A short description of the WebLogic Auditing provider.

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

      EndMarker

      The marker that indicates the end of the audit record.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueAudit Record End ####

      ErrorAuditSeverityEnabled

      If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of ERROR.

             
      Privileges Read/Write
      Typeboolean

      FailureAuditSeverityEnabled

      If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of FAILURE.

             
      Privileges Read/Write
      Typeboolean

      FieldPrefix

      The prefix character that indicates the beginning of a field in the audit record.

             
      Privileges Read/Write
      Typejava.lang.String
      Default Value <

      FieldSuffix

      The suffix character that indicates the end of a field in the audit record

             
      Privileges Read/Write
      Typejava.lang.String
      Default Value>

      InformationAuditSeverityEnabled

      If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of INFORMATION.

             
      Privileges Read/Write
      Typeboolean

      Name

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

      OutputMedium

      No description provided.

             
      Privileges Read/Write
      Typejava.lang.String

      ProviderClassName

      The Java class used to load the WebLogic Auditing provider.

             
      Privileges Read only
      Typejava.lang.String
      Default Valueweblogic.security.providers.audit.DefaultAuditProviderImpl
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      RotationMinutes

      Specifies how many minutes to wait before creating a new DefaultAuditRecorder.log file. At the specified time, the audit file is closed and a new one is created.

             
      Privileges Read/Write
      Typeint
      Default Value1440
      Minimum value1

      Severity

      The severity level at which auditing is initiated.

      Severity levels are ranked in this order:

      1. INFORMATION

      2. WARNING

      3. ERROR

      4. SUCCESS

      5. FAILURE

      If you select a given severity level, all events of that level or more will be audited. For example, if you set the severity to ERROR, then all FAILURE, SUCCESS, and ERROR events will be audited, but WARNING and INFORMATION events will not. You can instead set the severity to CUSTOM and then enable the specific severity level events you want to audit.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueERROR
      Legal Values
      • INFORMATION
      • WARNING
      • ERROR
      • SUCCESS
      • FAILURE
      • CUSTOM

      SuccessAuditSeverityEnabled

      If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of SUCCESS.

             
      Privileges Read/Write
      Typeboolean

      SupportedContextHandlerEntries

      List of all ContextHandler entries supported by the audit provider.

             
      Privileges Read only
      Typeclass java.lang.String[]
      Default Value com.bea.contextelement.servlet.HttpServletRequest com.bea.contextelement.servlet.HttpServletResponse com.bea.contextelement.wli.Message com.bea.contextelement.channel.Port com.bea.contextelement.channel.PublicPort com.bea.contextelement.channel.RemotePort com.bea.contextelement.channel.Protocol com.bea.contextelement.channel.Address com.bea.contextelement.channel.PublicAddress com.bea.contextelement.channel.RemoteAddress com.bea.contextelement.channel.ChannelName com.bea.contextelement.channel.Secure com.bea.contextelement.ejb20.Parameter com.bea.contextelement.wsee.SOAPMessage com.bea.contextelement.entitlement.EAuxiliaryID com.bea.contextelement.security.ChainPrevailidatedBySSL com.bea.contextelement.xml.SecurityToken com.bea.contextelement.xml.SecurityTokenAssertion com.bea.contextelement.webservice.Integrity com.bea.contextelement.saml.SSLClientCertificateChain com.bea.contextelement.saml.MessageSignerCertificate com.bea.contextelement.saml.subject.ConfirmationMethod com.bea.contextelement.saml.subject.dom.KeyInfo com.bea.contextelement.jmx.ObjectName com.bea.contextelement.jmx.ShortName com.bea.contextelement.jmx.Parameters com.bea.contextelement.jmx.Signature com.bea.contextelement.jmx.AuditProtectedArgInfo com.bea.contextelement.jmx.OldAttributeValue
      Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

      Version

      The version number of the WebLogic Auditing provider.

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

      WarningAuditSeverityEnabled

      If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of WARNING.

             
      Privileges Read/Write
      Typeboolean


      Operations

      This section describes the following operations:


      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
      Exceptions
      • java.lang.IllegalArgumentException

      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
      Exceptions
      • java.lang.IllegalArgumentException
        UnsupportedOperationException if called on a runtime implementation.

      wls_getDisplayName

      Returns the display name of an MBean.

      Deprecated 9.0.0.0

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString