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

Part Number E13945-04

weblogic.security.providers.audit
Interface DefaultAuditorMBean

All Superinterfaces:
AuditorMBean, ContextHandlerMBean, ProviderMBean

public interface DefaultAuditorMBean
extends AuditorMBean, ContextHandlerMBean

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.


Method Summary
 String getBeginMarker()
          The marker that indicates the beginning of the audit record.
 String getDescription()
          A short description of the WebLogic Auditing provider.
 String getEndMarker()
          The marker that indicates the end of the audit record.
 boolean getErrorAuditSeverityEnabled()
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of ERROR.
 boolean getFailureAuditSeverityEnabled()
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of FAILURE.
 String getFieldPrefix()
          The prefix character that indicates the beginning of a field in the audit record.
 String getFieldSuffix()
          The suffix character that indicates the end of a field in the audit record
 boolean getInformationAuditSeverityEnabled()
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of INFORMATION.
 String getName()
          The name of this configuration.
 String getOutputMedium()
          No description provided.
 String getProviderClassName()
          The Java class used to load the WebLogic Auditing provider.
 int getRotationMinutes()
          Specifies how many minutes to wait before creating a new DefaultAuditRecorder.log file.
 String getSeverity()
          The severity level at which auditing is initiated.
 boolean getSuccessAuditSeverityEnabled()
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of SUCCESS.
 String[] getSupportedContextHandlerEntries()
          List of all ContextHandler entries supported by the audit provider.
 String getVersion()
          The version number of the WebLogic Auditing provider.
 boolean getWarningAuditSeverityEnabled()
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of WARNING.
 void setBeginMarker(String newValue)
          The marker that indicates the beginning of the audit record.
 void setEndMarker(String newValue)
          The marker that indicates the end of the audit record.
 void setErrorAuditSeverityEnabled(boolean newValue)
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of ERROR.
 void setFailureAuditSeverityEnabled(boolean newValue)
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of FAILURE.
 void setFieldPrefix(String newValue)
          The prefix character that indicates the beginning of a field in the audit record.
 void setFieldSuffix(String newValue)
          The suffix character that indicates the end of a field in the audit record
 void setInformationAuditSeverityEnabled(boolean newValue)
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of INFORMATION.
 void setOutputMedium(String newValue)
          No description provided.
 void setRotationMinutes(int newValue)
          Specifies how many minutes to wait before creating a new DefaultAuditRecorder.log file.
 void setSeverity(String newValue)
          The severity level at which auditing is initiated.
 void setSuccessAuditSeverityEnabled(boolean newValue)
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of SUCCESS.
 void setWarningAuditSeverityEnabled(boolean newValue)
          If the Severity value is set to Custom, causes the Auditing provider to generate audit records for events with a severity level of WARNING.
 
Methods inherited from interface weblogic.management.security.ProviderMBean
getRealm
 
Methods inherited from interface weblogic.management.security.audit.ContextHandlerMBean
getActiveContextHandlerEntries, setActiveContextHandlerEntries
 

Method Detail

getProviderClassName

String getProviderClassName()

The Java class used to load the WebLogic Auditing provider.

Default Value:
"weblogic.security.providers.audit.DefaultAuditProviderImpl"

getDescription

String getDescription()

A short description of the WebLogic Auditing provider.

Specified by:
getDescription in interface ProviderMBean
Default Value:
"WebLogic Auditing Provider"

getVersion

String getVersion()

The version number of the WebLogic Auditing provider.

Specified by:
getVersion in interface ProviderMBean
Default Value:
"1.0"

getSeverity

String getSeverity()

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.

Changes take effect after you redeploy the module or restart the server.
Default Value:
"ERROR"
Valid Values:
"INFORMATION","WARNING","ERROR","SUCCESS","FAILURE","CUSTOM"

setSeverity

void setSeverity(String newValue)
                 throws InvalidAttributeValueException

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.

Parameters:
newValue - - new value for attribute Severity
Throws:
InvalidAttributeValueException
Changes take effect after you redeploy the module or restart the server.
Default Value:
"ERROR"
Valid Values:
"INFORMATION","WARNING","ERROR","SUCCESS","FAILURE","CUSTOM"

getInformationAuditSeverityEnabled

boolean getInformationAuditSeverityEnabled()

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

Changes take effect after you redeploy the module or restart the server.
Default Value:
false

setInformationAuditSeverityEnabled

void setInformationAuditSeverityEnabled(boolean newValue)
                                        throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute InformationAuditSeverityEnabled
Throws:
InvalidAttributeValueException
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

getWarningAuditSeverityEnabled

boolean getWarningAuditSeverityEnabled()

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

Changes take effect after you redeploy the module or restart the server.
Default Value:
false

setWarningAuditSeverityEnabled

void setWarningAuditSeverityEnabled(boolean newValue)
                                    throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute WarningAuditSeverityEnabled
Throws:
InvalidAttributeValueException
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

getErrorAuditSeverityEnabled

boolean getErrorAuditSeverityEnabled()

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

Changes take effect after you redeploy the module or restart the server.
Default Value:
false

setErrorAuditSeverityEnabled

void setErrorAuditSeverityEnabled(boolean newValue)
                                  throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute ErrorAuditSeverityEnabled
Throws:
InvalidAttributeValueException
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

getSuccessAuditSeverityEnabled

boolean getSuccessAuditSeverityEnabled()

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

Changes take effect after you redeploy the module or restart the server.
Default Value:
false

setSuccessAuditSeverityEnabled

void setSuccessAuditSeverityEnabled(boolean newValue)
                                    throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute SuccessAuditSeverityEnabled
Throws:
InvalidAttributeValueException
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

getFailureAuditSeverityEnabled

boolean getFailureAuditSeverityEnabled()

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

Changes take effect after you redeploy the module or restart the server.
Default Value:
false

setFailureAuditSeverityEnabled

void setFailureAuditSeverityEnabled(boolean newValue)
                                    throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute FailureAuditSeverityEnabled
Throws:
InvalidAttributeValueException
Changes take effect after you redeploy the module or restart the server.
Default Value:
false

getOutputMedium

String getOutputMedium()
No description provided.


setOutputMedium

void setOutputMedium(String newValue)
                     throws InvalidAttributeValueException
No description provided.

Parameters:
newValue - - new value for attribute OutputMedium
Throws:
InvalidAttributeValueException

getRotationMinutes

int getRotationMinutes()

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.

Default Value:
1440
Minimum Value:
1

setRotationMinutes

void setRotationMinutes(int newValue)
                        throws InvalidAttributeValueException

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.

Parameters:
newValue - - new value for attribute RotationMinutes
Throws:
InvalidAttributeValueException
Default Value:
1440
Minimum Value:
1

getSupportedContextHandlerEntries

String[] getSupportedContextHandlerEntries()

List of all ContextHandler entries supported by the audit provider.

Specified by:
getSupportedContextHandlerEntries in interface ContextHandlerMBean
Default Value:
weblogic.security.providers.audit.DefaultAuditProviderImpl.SUPPORTED_ELEMENT_NAMES

getBeginMarker

String getBeginMarker()

The marker that indicates the beginning of the audit record.

Default Value:
"#### Audit Record Begin"

setBeginMarker

void setBeginMarker(String newValue)
                    throws InvalidAttributeValueException

The marker that indicates the beginning of the audit record.

Parameters:
newValue - - new value for attribute BeginMarker
Throws:
InvalidAttributeValueException
Default Value:
"#### Audit Record Begin"

getEndMarker

String getEndMarker()

The marker that indicates the end of the audit record.

Default Value:
"Audit Record End ####"

setEndMarker

void setEndMarker(String newValue)
                  throws InvalidAttributeValueException

The marker that indicates the end of the audit record.

Parameters:
newValue - - new value for attribute EndMarker
Throws:
InvalidAttributeValueException
Default Value:
"Audit Record End ####"

getFieldPrefix

String getFieldPrefix()

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

Default Value:
" <"

setFieldPrefix

void setFieldPrefix(String newValue)
                    throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute FieldPrefix
Throws:
InvalidAttributeValueException
Default Value:
" <"

getFieldSuffix

String getFieldSuffix()

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

Default Value:
"> "

setFieldSuffix

void setFieldSuffix(String newValue)
                    throws InvalidAttributeValueException

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

Parameters:
newValue - - new value for attribute FieldSuffix
Throws:
InvalidAttributeValueException
Default Value:
"> "

getName

String getName()
Description copied from interface: ProviderMBean
The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

Specified by:
getName in interface ProviderMBean
Default Value:
"DefaultAuditor"

Copyright 1996, 2010, 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.4)

Part Number E13945-04