# DBMSAuthenticatorMBean (Abstract)

Overview | Related MBeans | Attributes | Operations

## Overview

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://edocs.bea.com.

Fully Qualified Interface Name | If you use the `getMBeanInfo` operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name: `weblogic.security.providers.authentication.DBMSAuthenticatorMBean`
Factory Methods | No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from AuthenticationProviderMBean | Because this MBean extends or implements AuthenticationProviderMBean, you can also access this MBean by retrieving AuthenticationProviderMBeans. The following attributes contain AuthenticationProviderMBeans and its subtypes:
RealmMBean.AuthenticationProviders |
Subtypes | The following MBeans extend or implement this MBean type:
CustomDBMSAuthenticatorMBean ReadOnlySQLAuthenticatorMBean | SQLAuthenticatorMBean

## Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

Realm |

### Realm

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

Privileges | Read only
Type | RealmMBean
Relationship type: | Reference.

## Attributes

This section describes the following attributes:

ControlFlag DataSourceName Description EnableGroupMembershipLookupHierarchyCaching GroupHierarchyCacheTTL GroupMembershipSearching MaxGroupHierarchiesInCache | MaxGroupMembershipSearchLevel Name PlaintextPasswordsEnabled ProviderClassName Version

### ControlFlag

Returns how the login sequence uses the Authentication provider.

A `REQUIRED` value specifies this LoginModule must succeed. Even if it fails, authentication proceeds down the list of LoginModules for the configured Authentication providers. This setting is the default.

A `REQUISITE` value specifies this LoginModule must succeed. If other Authentication providers are configured and this LoginModule succeeds, authentication proceeds down the list of LoginModules. Otherwise, control is return to the application.

A `SUFFICIENT` value specifies this LoginModule need not succeed. If it does succeed, return control to the application. If it fails and other Authentication providers are configured, authentication proceeds down the LoginModule list.

An `OPTIONAL` value specifies this LoginModule need not succeed. Whether it succeeds or fails, authentication proceeds down the LoginModule list.

Privileges | Read/Write
Type | java.lang.String
Default Value | REQUIRED
Legal Values | REQUIRED REQUISITE SUFFICIENT OPTIONAL

### DataSourceName

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

Privileges | Read/Write
Type | java.lang.String

### Description

A short description of the DBMS Authentication provider.

Privileges | Read only
Type | java.lang.String
Default Value | Provider that performs DBMS authentication
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### EnableGroupMembershipLookupHierarchyCaching

Returns whether group membership hierarchies found during recursive membership lookup will be cached. If true, each subtree found will be cached.

Privileges | Read/Write
Type | java.lang.Boolean

### GroupHierarchyCacheTTL

Returns the maximum number of seconds a group membership hierarchy entry is valid in the LRU cache.

Privileges | Read/Write
Type | java.lang.Integer
Default Value | 60

### GroupMembershipSearching

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

Privileges | Read/Write
Type | java.lang.String
Default Value | unlimited
Legal Values | unlimited limited

### MaxGroupHierarchiesInCache

Returns the maximum size of the LRU cache for holding group membership hierarchies if caching is enabled.

Privileges | Read/Write
Type | java.lang.Integer
Default Value | 100

### MaxGroupMembershipSearchLevel

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.

Privileges | Read/Write
Type | java.lang.Integer
Default Value | 0

### Name

Privileges | Read only
Type | java.lang.String
Default Value | DBMSAuthenticator
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### PlaintextPasswordsEnabled

Indicates whether plaintext passwords are allowed to be used.

Privileges | Read/Write
Type | boolean

### ProviderClassName

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

Privileges | Read only
Type | java.lang.String
Default Value | weblogic.security.providers.authentication.DBMSAuthenticationProviderImpl
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

### Version

The version number of the DBMS Authentication provider.

Privileges | Read only
Type | java.lang.String
Default Value | 1.0
Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server.

## Operations

This section describes the following operations:

wls_getDisplayName |

### wls_getDisplayName

Operation Name | `"wls_getDisplayName"`
Parameters | `null`
Signature | `null`
Returns | `String`