AuthenticatorMBean (Abstract)

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

The SSPI MBean that all Authentication providers with login services must extend. This MBean provides a ControlFlag to determine whether the Authentication provider is a REQUIRED, REQUISITE, SUFFICIENT, or OPTIONAL part of the login sequence.

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.management.security.authentication.AuthenticatorMBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.    
Subtypes The following MBeans extend or implement this MBean type:

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

    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

    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

     

    Description

    Returns a description of this security provider.

    Each security provider's MBean should set the default value of this read-only attribute to a string that describes the provider. In other words, each security provider's MBean hard-wires its description. There are no conventions governing the contents of the description. It should be a human readable string that gives a brief description of the security provider.

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

     

    Name of

    Name of configuration. WebLogic Server uses an MBean to implement and persist the configuration.

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

     

    Version

    Returns this security provider's version.

    Each security provider's MBean should set the default value of this read-only attribute to a string that specifies the version of the provider (e.g. 7.3.04). In other words, each security provider's MBean hard-wires its version. There are no conventions governing the contents of the version string.

       
    Privileges Read only    
    Type java.lang.String
    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"    
    Parameters Object [] {  propertyName }

    where:

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

      property to check

    Signature String [] { "java.lang.String" }
    Returns boolean
    Exceptions

    • java.lang.IllegalArgumentException

     

    unSet

    Restore the given property to its default value.

    Operation Name "unSet"    
    Parameters Object [] {  propertyName }

    where:

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

      property to restore

    Signature String [] { "java.lang.String" }
    Returns void
    Exceptions

    • java.lang.IllegalArgumentException
      UnsupportedOperationException if called on a runtime implementation.

     

    wls_getDisplayName

    Operation Name "wls_getDisplayName"    
    Parameters null
    Signature null
    Returns String