Type-Safe Access to BEA WebLogic Server 9.2 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.security.providers.audit
Interface DefaultAuditorMBean

All Superinterfaces:

AuditorMBean, ContextHandlerMBean, weblogic.descriptor.DescriptorBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

public interface DefaultAuditorMBean

extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, 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. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

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.commo.StandardInterface

setName, wls_getDisplayName, wls_getInterfaceClassName, wls_getObjectName

Methods inherited from interface weblogic.descriptor.DescriptorBean

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Methods inherited from interface weblogic.descriptor.SettableBean

isSet, unSet

Methods inherited from interface weblogic.management.security.ProviderMBean

getRealm

Methods inherited from interface weblogic.management.security.audit.ContextHandlerMBean

getActiveContextHandlerEntries, setActiveContextHandlerEntries

Method Detail

getBeginMarker

public String getBeginMarker()

The marker that indicates the beginning of the audit record.

getDescription

public String getDescription()

A short description of the WebLogic Auditing provider.

Specified by:

getDescription in interface ProviderMBean

getEndMarker

public String getEndMarker()

The marker that indicates the end of the audit record.

getErrorAuditSeverityEnabled

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

getFailureAuditSeverityEnabled

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

getFieldPrefix

public String getFieldPrefix()

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

getFieldSuffix

public String getFieldSuffix()

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

getInformationAuditSeverityEnabled

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

getName

public 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 weblogic.management.commo.StandardInterface

getOutputMedium

public String getOutputMedium()

No description provided.

getProviderClassName

public String getProviderClassName()

The Java class used to load the WebLogic Auditing provider.

Specified by:

getProviderClassName in interface ProviderMBean

Excluded: Should not appear in public javadocs

Internal: Should not appear in public javadocs

getRotationMinutes

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

getSeverity

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

getSuccessAuditSeverityEnabled

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

getSupportedContextHandlerEntries

public String[] getSupportedContextHandlerEntries()

List of all ContextHandler entries supported by the audit provider.

Specified by:

getSupportedContextHandlerEntries in interface ContextHandlerMBean

getVersion

public String getVersion()

The version number of the WebLogic Auditing provider.

Specified by:

getVersion in interface ProviderMBean

getWarningAuditSeverityEnabled

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

setBeginMarker

public 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

setEndMarker

public 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

setErrorAuditSeverityEnabled

public 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

setFailureAuditSeverityEnabled

public 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

setFieldPrefix

public 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

setFieldSuffix

public 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

setInformationAuditSeverityEnabled

public 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

setOutputMedium

public void setOutputMedium(String newValue)
                     throws InvalidAttributeValueException

No description provided.

Parameters:

newValue - - new value for attribute OutputMedium

Throws:

InvalidAttributeValueException

setRotationMinutes

public 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

setSeverity

public 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

setSuccessAuditSeverityEnabled

public 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

setWarningAuditSeverityEnabled

public 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