UserAttributeReaderMBean (Abstract)


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides a set of methods for getting a list of supported users attributes and their types. Methods are also provided to get user attribute values. An Authentication provider MBean can optionally implement this MBean. The WebLogic Server Administration Console detects when an Authentication provider implements this MBean and automatically provides a tab for using these methods.

       
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.security.authentication.UserAttributeReaderMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Subtypes The following MBeans extend or implement this MBean type:


    Attributes

    This section describes the following attributes:


      SupportedUserAttributeNames

      Provides a list of supported user attribute names for the provider.

             
      Privileges Read only
      Typeclass 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:


      getSupportedUserAttributeType

      Returns the user attribute type

         
      Operation Name"getSupportedUserAttributeType"
      ParametersObject [] {  userAttributeName }

      where:

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

        User attribute name

      SignatureString [] { "java.lang.String" }
      ReturnsOpenType
      Exceptions
      • weblogic.management.utils.InvalidParameterException

      getUserAttributeValue

      Gets a user attribute value for a user. If the user attribute is unset,a null would be returned.

         
      Operation Name"getUserAttributeValue"
      ParametersObject [] {  userNameuserAttributeName }

      where:

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

        - The name of an existing user.

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

        - The name of an existing attribute

      SignatureString [] { "java.lang.String", "java.lang.String" }
      ReturnsObject
      Exceptions
      • weblogic.management.utils.NotFoundException
      • weblogic.management.utils.InvalidParameterException

      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

      isUserAttributeNameSupported

      Checks if a user attribute is supported.

         
      Operation Name"isUserAttributeNameSupported"
      ParametersObject [] {  userAttributeName }

      where:

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

        User attribute name

      SignatureString [] { "java.lang.String" }
      Returns boolean
      Exceptions
      • weblogic.management.utils.InvalidParameterException

      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

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString