SAMLAuthenticatorMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean represents configuration information for the SAML 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.saml.SAMLAuthenticatorMBean
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

    Description

    A short description of the SAML Authentication provider.

           
    Privileges Read only
    Typejava.lang.String
    Default ValueWebLogic SAML Authentication Provider.
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Name

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

    ProviderClassName

    The name of the Java class used to load the SAML Authentication provider.

           
    Privileges Read only
    Typejava.lang.String
    Default Valueweblogic.security.providers.saml.SAMLAuthenticationProviderImpl
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Version

    The version number of the SAML 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