BEA Systems, Inc.

Type-Safe Access to BEA WebLogic Server 9.0 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 InterfacesThis 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.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Method Summary
 String getDescription()
          A short description of the WebLogic Auditing provider.
 String getName()
          The name of this configuration.
 String getOutputMedium()
          An output repository for the audit information.
 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.
 String[] getSupportedContextHandlerEntries()
          No description provided.
 String getVersion()
          The version number of the WebLogic Auditing provider.
 void setOutputMedium(String newValue)
          An output repository for the audit information.
 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.
 
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

getDescription

public String getDescription()
A short description of the WebLogic Auditing provider.

Specified by:
getDescription in interface ProviderMBean
Default value:
"WebLogic Auditing Provider"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

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
Default value:
"DefaultAuditor"
A dynamic MBean attribute.
false

getOutputMedium

public String getOutputMedium()
An output repository for the audit information. This repository can be an LDAP server, database, or a simple file. This attribute is optional.

A dynamic MBean attribute.
false

getProviderClassName

public String getProviderClassName()
The Java class used to load the WebLogic Auditing provider.

Specified by:
getProviderClassName in interface ProviderMBean
Default value:
"weblogic.security.providers.audit.DefaultAuditProviderImpl"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.
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.

Default value:
(new Integer(1440)).intValue()
Minimum value:
1
A dynamic MBean attribute.
false

getSeverity

public String getSeverity()
The severity level at which auditing is initiated.

Default value:
"ERROR"
Legal values:
"INFORMATION","WARNING","ERROR","SUCCESS","FAILURE"
A dynamic MBean attribute.
true

getSupportedContextHandlerEntries

public String[] getSupportedContextHandlerEntries()
No description provided.

Specified by:
getSupportedContextHandlerEntries in interface ContextHandlerMBean
Default value:
weblogic.security.providers.audit.DefaultAuditProviderImpl.SUPPORTED_ELEMENT_NAMES
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

getVersion

public String getVersion()
The version number of the WebLogic Auditing provider.

Specified by:
getVersion in interface ProviderMBean
Default value:
"1.0"
A dynamic MBean attribute.
false
A non-configurable MBean attribute.

setOutputMedium

public void setOutputMedium(String newValue)
                     throws InvalidAttributeValueException
An output repository for the audit information. This repository can be an LDAP server, database, or a simple file. This attribute is optional.

Parameters:
newValue - - new value for attribute OutputMedium
Throws:
InvalidAttributeValueException
A dynamic MBean attribute.
false

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
Default value:
(new Integer(1440)).intValue()
Minimum value:
1
A dynamic MBean attribute.
false

setSeverity

public void setSeverity(String newValue)
                 throws InvalidAttributeValueException
The severity level at which auditing is initiated.

Parameters:
newValue - - new value for attribute Severity
Throws:
InvalidAttributeValueException
Default value:
"ERROR"
Legal values:
"INFORMATION","WARNING","ERROR","SUCCESS","FAILURE"
A dynamic MBean attribute.
true

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs90
Copyright 2005 BEA Systems Inc.