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.authentication
Interface DBMSAuthenticatorMBean

All Superinterfaces:

AuthenticationProviderMBean, AuthenticatorMBean, weblogic.descriptor.DescriptorBean, GroupMembershipHierarchyCacheMBean, ProviderMBean, weblogic.descriptor.SettableBean, weblogic.management.commo.StandardInterface

All Known Subinterfaces:

CustomDBMSAuthenticatorMBean, ReadOnlySQLAuthenticatorMBean, SQLAuthenticatorMBean

public interface DBMSAuthenticatorMBean

extends weblogic.management.commo.StandardInterface, weblogic.descriptor.DescriptorBean, AuthenticatorMBean, GroupMembershipHierarchyCacheMBean

This MBean contains attributes for DBMS Authentication providers.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	getDataSourceName() The name of the JDBC data source used for database access.
String	getDescription() A short description of the DBMS Authentication provider.
String	getGroupMembershipSearching() Specifies whether recursive group membership searching is unlimited or limited.
Integer	getMaxGroupMembershipSearchLevel() This specifies how many levels of group membership can be searched.
String	getName() The name of this configuration.
String	getProviderClassName() The name of the Java class for the DBMS Authentication provider.
String	getVersion() The version number of the DBMS Authentication provider.
boolean	isPlaintextPasswordsEnabled() No description provided.
void	setDataSourceName(String newValue) The name of the JDBC data source used for database access.
void	setGroupMembershipSearching(String newValue) Specifies whether recursive group membership searching is unlimited or limited.
void	setMaxGroupMembershipSearchLevel(Integer newValue) This specifies how many levels of group membership can be searched.
void	setPlaintextPasswordsEnabled(boolean newValue) No description provided.

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.authentication.AuthenticatorMBean

getControlFlag, setControlFlag

Methods inherited from interface weblogic.management.security.ProviderMBean

getRealm

Methods inherited from interface weblogic.management.security.authentication.GroupMembershipHierarchyCacheMBean

getEnableGroupMembershipLookupHierarchyCaching, getGroupHierarchyCacheTTL, getMaxGroupHierarchiesInCache, setEnableGroupMembershipLookupHierarchyCaching, setGroupHierarchyCacheTTL, setMaxGroupHierarchiesInCache

Method Detail

getDataSourceName

public String getDataSourceName()

The name of the JDBC data source used for database access.

A dynamic MBean attribute.

true

getDescription

public String getDescription()

A short description of the DBMS Authentication provider.

Specified by:

getDescription in interface ProviderMBean

Default value:

"Provider that performs DBMS authentication"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

getGroupMembershipSearching

public String getGroupMembershipSearching()

Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited and limited.

Default value:

"unlimited"

Legal values:

"unlimited","limited"

A dynamic MBean attribute.

true

getMaxGroupMembershipSearchLevel

public Integer getMaxGroupMembershipSearchLevel()

This specifies how many levels of group membership can be searched. This setting is valid only if Group Membership Searching is set to limited. Valid values are 0 and positive integers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.

Default value:

new Integer(0)

A dynamic MBean attribute.

true

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:

"DBMSAuthenticator"

A dynamic MBean attribute.

false

getProviderClassName

public String getProviderClassName()

The name of the Java class for the DBMS Authentication provider.

Specified by:

getProviderClassName in interface ProviderMBean

Default value:

"weblogic.security.providers.authentication.DBMSAuthenticationProviderImpl"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

Excluded: Should not appear in public javadocs

Internal: Should not appear in public javadocs

getVersion

public String getVersion()

The version number of the DBMS Authentication provider.

Specified by:

getVersion in interface ProviderMBean

Default value:

"1.0"

A dynamic MBean attribute.

false

A non-configurable MBean attribute.

isPlaintextPasswordsEnabled

public boolean isPlaintextPasswordsEnabled()

No description provided.

Default value:

(new java.lang.Boolean(false)).booleanValue()

A dynamic MBean attribute.

true

setDataSourceName

public void setDataSourceName(String newValue)
                       throws InvalidAttributeValueException

The name of the JDBC data source used for database access.

Parameters:

newValue - - new value for attribute DataSourceName

Throws:

InvalidAttributeValueException

A dynamic MBean attribute.

true

setGroupMembershipSearching

public void setGroupMembershipSearching(String newValue)
                                 throws InvalidAttributeValueException

Specifies whether recursive group membership searching is unlimited or limited. Valid values are unlimited and limited.

Parameters:

newValue - - new value for attribute GroupMembershipSearching

Throws:

InvalidAttributeValueException

Default value:

"unlimited"

Legal values:

"unlimited","limited"

A dynamic MBean attribute.

true

setMaxGroupMembershipSearchLevel

public void setMaxGroupMembershipSearchLevel(Integer newValue)
                                      throws InvalidAttributeValueException

This specifies how many levels of group membership can be searched. This setting is valid only if Group Membership Searching is set to limited. Valid values are 0 and positive integers. For example, 0 indicates only direct group memberships will be found, a positive number indicates the number of levels to go down.

Parameters:

newValue - - new value for attribute MaxGroupMembershipSearchLevel

Throws:

InvalidAttributeValueException

Default value:

new Integer(0)

A dynamic MBean attribute.

true

setPlaintextPasswordsEnabled

public void setPlaintextPasswordsEnabled(boolean newValue)
                                  throws InvalidAttributeValueException

No description provided.

Parameters:

newValue - - new value for attribute PlaintextPasswordsEnabled

Throws:

InvalidAttributeValueException

Default value:

(new java.lang.Boolean(false)).booleanValue()

A dynamic MBean attribute.

true