CustomDBMSAuthenticatorMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

The MBean that represents configuration information for the Custom DBMS Authentication provider.

   
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.security.providers.authentication.CustomDBMSAuthenticatorMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.


Related MBeans

This section describes attributes that provide access to other MBeans.


    Realm

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

           
    Privileges Read only
    TypeRealmMBean
    Relationship type: Reference.


    Attributes

    This section describes the following attributes:


    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
    Typejava.lang.String
    Default ValueREQUIRED
    Legal Values
    • REQUIRED
    • REQUISITE
    • SUFFICIENT
    • OPTIONAL

    DataSourceName

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

           
    Privileges Read/Write
    Typejava.lang.String

    Description

    A short description of the DBMS Authentication provider.

           
    Privileges Read only
    Typejava.lang.String
    Default ValueProvider 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
    Typejava.lang.Boolean

    GroupHierarchyCacheTTL

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

           
    Privileges Read/Write
    Typejava.lang.Integer
    Default Value60

    GroupMembershipSearching

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

           
    Privileges Read/Write
    Typejava.lang.String
    Default Valueunlimited
    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
    Typejava.lang.Integer
    Default Value100

    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
    Typejava.lang.Integer
    Default Value0

    Name

           
    Privileges Read only
    Typejava.lang.String
    Default ValueCustomDBMSAuthenticator
    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
    Typeboolean

    PluginClassName

    Specifies the name of a class that implements the weblogic.security.providers.authentication.CustomDBMSAuthenticatorPlugin interface. The class must exist in the CLASSPATH. Required. No default value.

           
    Privileges Read/Write
    Typejava.lang.String

    PluginProperties

    Defines configuration properties for the specified plug-in class. The property names are defined by the plug-in class. Optional. No default value.

           
    Privileges Read/Write
    Typejava.util.Properties

    ProviderClassName

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

           
    Privileges Read only
    Typejava.lang.String
    Default Valueweblogic.security.providers.authentication.DBMSPluggableRuntimeAuthenticationProviderImpl
    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
    Typejava.lang.String
    Default Value1.0
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


    Operations

    This section describes the following operations:


    isSet

    Returns true if the specified attribute has been set explicitly in this MBean instance.

       
    Operation Name"isSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to check

    SignatureString [] { "java.lang.String" }
    Returns boolean
    Exceptions
    • java.lang.IllegalArgumentException

    unSet

    Restore the given property to its default value.

       
    Operation Name"unSet"
    ParametersObject [] {  propertyName }

    where:

    • propertyName is an object of type java.lang.String that specifies:

      property to restore

    SignatureString [] { "java.lang.String" }
    Returns void
    Exceptions
    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.

    wls_getDisplayName

    Returns the display name of an MBean.

    Deprecated 9.0.0.0

       
    Operation Name"wls_getDisplayName"
    Parametersnull
    Signaturenull
    ReturnsString