Oracle Fusion Middleware
Oracle WebLogic Server MBean Javadoc
12c Release 1 (12.1.1)

Part Number E24395-02

weblogic.security.providers.authentication
Interface DBMSAuthenticatorMBean

All Superinterfaces:
AuthenticationProviderMBean, AuthenticatorMBean, GroupMembershipHierarchyCacheMBean, ProviderMBean
All Known Subinterfaces:
CustomDBMSAuthenticatorMBean, ReadOnlySQLAuthenticatorMBean, SQLAuthenticatorMBean

public interface DBMSAuthenticatorMBean
extends AuthenticatorMBean, GroupMembershipHierarchyCacheMBean

This MBean contains attributes for DBMS Authentication providers.

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 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()
          Indicates whether plaintext passwords are allowed to be used.
 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)
          Indicates whether plaintext passwords are allowed to be used.
 
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

getProviderClassName

String getProviderClassName()

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

Default Value:
"weblogic.security.providers.authentication.DBMSAuthenticationProviderImpl"

getDescription

String getDescription()

A short description of the DBMS Authentication provider.

Specified by:
getDescription in interface ProviderMBean
Default Value:
"Provider that performs DBMS authentication"

getVersion

String getVersion()

The version number of the DBMS Authentication provider.

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

getDataSourceName

String getDataSourceName()

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

Changes take effect after you redeploy the module or restart the server.

setDataSourceName

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
Changes take effect after you redeploy the module or restart the server.

getGroupMembershipSearching

String getGroupMembershipSearching()

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

Changes take effect after you redeploy the module or restart the server.
Default Value:
"unlimited"
Valid Values:
"unlimited","limited"

setGroupMembershipSearching

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
Changes take effect after you redeploy the module or restart the server.
Default Value:
"unlimited"
Valid Values:
"unlimited","limited"

getMaxGroupMembershipSearchLevel

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.

Changes take effect after you redeploy the module or restart the server.
Default Value:
new Integer(0)

setMaxGroupMembershipSearchLevel

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
Changes take effect after you redeploy the module or restart the server.
Default Value:
new Integer(0)

isPlaintextPasswordsEnabled

boolean isPlaintextPasswordsEnabled()

Indicates whether plaintext passwords are allowed to be used.

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

setPlaintextPasswordsEnabled

void setPlaintextPasswordsEnabled(boolean newValue)
                                  throws InvalidAttributeValueException

Indicates whether plaintext passwords are allowed to be used.

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

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:
"DBMSAuthenticator"

Copyright 1996, 2011, 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
12c Release 1 (12.1.1)

Part Number E24395-02