SQLAuthenticatorMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

This MBean contains configuration information for the SQL 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.SQLAuthenticatorMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from AuthenticationProviderMBean Because this MBean extends or implements AuthenticationProviderMBean, you can also access this MBean by retrieving AuthenticationProviderMBeans. The following attributes contain AuthenticationProviderMBeans and its subtypes:


    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.

      DescriptionsSupported

      Indicates whether user and group descriptions are supported by the database used by the authentication provider.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

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

      PasswordAlgorithm

      The message digest algorithm used to hash passwords for storage. The name must be recognized by a Java Cryptography Extension (JCE) provider that is available at runtime.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSHA-1

      PasswordStyle

      Indicates the password style that is used when storing passwords for users that are created and for changing the user's password if Password Style Retained is disabled.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSALTEDHASHED
      Legal Values
      • PLAINTEXT
      • HASHED
      • SALTEDHASHED

      PasswordStyleRetained

      Controls how a password is stored in the database when updating an existing user's password.

             
      Privileges Read/Write
      Typeboolean
      Default Valuetrue

      PlaintextPasswordsEnabled

      Indicates whether plaintext passwords are allowed to be used.

             
      Privileges Read/Write
      Typeboolean

      ProviderClassName

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

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

      SQLAddMemberToGroup

      The SQL statement used to add a specific member to a group. The SQL statement requires two parameters: the group name and the group member being added.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueINSERT INTO GROUPMEMBERS VALUES( ?, ?)

      SQLCreateGroup

      The SQL statement requirements depend on the value of Descriptions Supported. There is a minimum of one parameter, the group name. If Descriptions Supported is true, the group's description is required. The default SQL is based on the default setting of Descriptions Supported. The setting of Create Group must be updated manually if the setting of Descriptions Supported changes.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueINSERT INTO GROUPS VALUES ( ? , ? )

      SQLCreateUser

      The SQL statement used to create a new user record The SQL statement requirements depend on the value of Descriptions Supported. There are a minimum of two parameters: a username and its associated password. If Descriptions Supported is true, the user's description is required. The default SQL is based on the default setting of Descriptions Supported. The setting of Create User must be updated manually if the setting of Descriptions Supported changes.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueINSERT INTO USERS VALUES ( ? , ? , ? )

      SQLGetGroupDescription

      The SQL statement used to retrieve the description of a group. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group description.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT G_DESCRIPTION FROM GROUPS WHERE G_NAME = ?

      SQLGetUserDescription

      The SQL statement used to retrieve the description of a specific user. Only valid if Descriptions Supported is enabled. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user description.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT U_DESCRIPTION FROM USERS WHERE U_NAME = ?

      SQLGetUsersPassword

      The SQL statement used to look up a user's password. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the password.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT U_PASSWORD FROM USERS WHERE U_NAME = ?

      SQLGroupExists

      The SQL statement used to look up a group. The SQL statement requires a single parameter for the group name and must return a resultSet containing at most a single record containing the group

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT G_NAME FROM GROUPS WHERE G_NAME = ?

      SQLIsMember

      The SQL statement used to look up members of a group. The SQL statement requires two parameters: a group name and a member or group name. It must return a resultSet containing the group names that matched

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT G_MEMBER FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER = ?

      SQLListGroupMembers

      The SQL statement used to list groups that have a group name with a list of wildcarded member names. The SQL statement requires two parameters: the group name and the wildcarded member name.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT G_MEMBER FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER LIKE ?

      SQLListGroups

      The SQL statement used to retrieve group names that match a wildcard The SQL statement requires a single parameter for the wildcarded group name and return a resultSet containing matching group names

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT G_NAME FROM GROUPS WHERE G_NAME LIKE ?

      SQLListMemberGroups

      The SQL statement used to look up the groups a user or group is a member of. The SQL statement requires a single parameter for the username or group name and returns a resultSet containing the names of the groups that matched.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT G_NAME FROM GROUPMEMBERS WHERE G_MEMBER = ?

      SQLListUsers

      The SQL statement used to retrieve users that match a particular wildcard search The SQL statement requires a single parameter for the wildcarded usernames and returns a resultSet containing matching usernames

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT U_NAME FROM USERS WHERE U_NAME LIKE ?

      SQLRemoveGroup

      The SQL statement used to remove a member from a group. The SQL statement requires a single parameter: the group name being removed.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDELETE FROM GROUPS WHERE G_NAME = ?

      SQLRemoveGroupMember

      The SQL statement used to remove a member from a group. The SQL statement requires a single parameter: the username or group name being removed.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDELETE FROM GROUPMEMBERS WHERE G_NAME = ?

      SQLRemoveGroupMemberships

      The SQL statement used to delete a group member (either a user or group) from all groups to which it belongs. The SQL statement requires 2 parameters.Both parameters refer to the specific username or group name being removed.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDELETE FROM GROUPMEMBERS WHERE G_MEMBER = ? OR G_NAME = ?

      SQLRemoveMemberFromGroup

      The SQL statement used to remove a member from a group. The SQL statement requires two parameters: the group name and the group member being deleted from the group.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDELETE FROM GROUPMEMBERS WHERE G_NAME = ? AND G_MEMBER = ?

      SQLRemoveUser

      The SQL statement used for deleting a user. The SQL statement requires a single parameter, the username.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueDELETE FROM USERS WHERE U_NAME = ?

      SQLSetGroupDescription

      The SQL statement used to specify a description for a group. Only valid if Descriptions Supported attribute is enabled. The SQL statement requires two parameters: the group description and the group name.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueUPDATE GROUPS SET G_DESCRIPTION = ? WHERE G_NAME = ?

      SQLSetUserDescription

      The SQL statement used to specify description for a user. Only valid if Descriptions Supported is true. The SQL statement requires two parameters: the username description and the username.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueUPDATE USERS SET U_DESCRIPTION = ? WHERE U_NAME = ?

      SQLSetUserPassword

      The SQL statement used to set the password for a user. The SQL statement requires two parameters: the password for the user and the username.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueUPDATE USERS SET U_PASSWORD = ? WHERE U_NAME = ?

      SQLUserExists

      The SQL statement used to look up a user. The SQL statement requires a single parameter for the username and must return a resultSet containing at most a single record containing the user.

             
      Privileges Read/Write
      Typejava.lang.String
      Default ValueSELECT U_NAME FROM USERS WHERE U_NAME = ?

      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:


      addMemberToGroup

      Adds a user or group (member) to a group. If the member already belongs to the group, this method does nothing.

         
      Operation Name"addMemberToGroup"
      ParametersObject [] {  groupNamememberUserOrGroupName }

      where:

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

        - The name of an existing group to which this method adds a member.

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

        - The name of the member, which must be an existing user or group.

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

      advance

      Advances the list to the next element in the list.

         
      Operation Name"advance"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.

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

      changeUserPassword

      Used by a user to change his or her password.

         
      Operation Name"changeUserPassword"
      ParametersObject [] {  userNameoldPasswordnewPassword }

      where:

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

        - The name of an existing user.

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

        - The current password for the user.

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

        - The new password for the user. The Authentication provider determines the syntax requirements for passwords.

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

      close

      Indicates that the caller is finished using the list, and that the resources held on behalf of the list may be released. If the caller traverses through all the elements in the list, the caller need not call this method. In other words, it is used to let the caller close the list without reading each element that is returned.

         
      Operation Name"close"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.

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

      createGroup

      Creates a group.

         
      Operation Name"createGroup"
      ParametersObject [] {  groupNamedescription }

      where:

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

        - The name of the new group. The name cannot be the name of an existing user or group. The Authentication provider determines syntax requirements for the group name.

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

        - The description of the group.

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

      createUser

      Creates a user and sets the user's password.

         
      Operation Name"createUser"
      ParametersObject [] {  userNamepassworddescription }

      where:

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

        - The name of the new user. The name cannot be the name of an existing user or group. The Authentication provider determines syntax requirements for the user name.

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

        - The password for the new user. The Authentication provider determines syntax requirements for passwords.

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

        - The description of the user.

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

      getCurrentName

      The name of the current item in the list. Returns null if there is no current item.

         
      Operation Name"getCurrentName"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.

      SignatureString [] { "java.lang.String" }
      ReturnsString
      Exceptions
      • weblogic.management.utils.InvalidCursorException

      getGroupDescription

      Gets a group's description.

         
      Operation Name"getGroupDescription"
      ParametersObject [] {  groupName }

      where:

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

        - The name of an existing group.

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

      getUserDescription

      Gets a user's description.

         
      Operation Name"getUserDescription"
      ParametersObject [] {  userName }

      where:

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

        - The name of an existing user.

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

      groupExists

      Indicates whether the specified group exists.

         
      Operation Name"groupExists"
      ParametersObject [] {  groupName }

      where:

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

        - The name that this method evaluates.

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

      haveCurrent

      Returns true if there are more objects in the list, and false otherwise.

         
      Operation Name"haveCurrent"
      ParametersObject [] {  cursor }

      where:

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

        - The cursor returned from a previous list method.

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

      isMember

      Indicates whether a user or group is a member of the group that you specify. A recursive search returns true if the member belongs to the group that you specify or to any of the groups contained within that group."

         
      Operation Name"isMember"
      ParametersObject [] {  parentGroupNamememberUserOrGroupNamerecursive }

      where:

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

        - The existing group within which this method searches for membership.

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

        - The user or group name for which this method searches.

      • recursive is an object of type java.lang.Boolean that specifies:

        - If set to true, the criteria for membership extends to any groups within the group that is specified by parentGroupName.

        If this argument is set to false, then this method checks only for direct membership within the parentGroupName.

      SignatureString [] { "java.lang.String", "java.lang.String", "java.lang.Boolean" }
      Returns boolean
      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

      listGroupMembers

      Searches within a group for user and group (member) names that match a pattern. Returns a cursor (string). You can use methods from weblogic.management.utils.NameLister (which this MBean extends) to iterate through the returned list.

      This method does not sort the results or distinguish user and group names. You can use the groupExists method to determine whether a name refers to an existing group.

         
      Operation Name"listGroupMembers"
      ParametersObject [] {  groupNamememberUserOrGroupNameWildcardmaximumToReturn }

      where:

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

        - The existing group within which this method searches for members.

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

        - The pattern for which this method searches The pattern can end with an * (asterisk) as a wildcard, which matches any string of characters. ' *

        For example, a pattern of abc matches exactly one name that contains only abc, a pattern of ab* matches all user and group names that start with ab, and a pattern of * matches all user and group names.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of user and group names that this method returns. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort results. If this parameter is set to 0, all results are returned.

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

      listGroups

      Searches for a user name that matches a pattern.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.NameListerMBean (which this MBean extends) to iterate through the returned list.

      This method does not sort the results.

         
      Operation Name"listGroups"
      ParametersObject [] {  groupNameWildcardmaximumToReturn }

      where:

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

        -

        The pattern for which this method searches. The pattern can end with an * (asterisk) as a wildcard, which matches any string of characters.

        For example, a pattern of abc matches exactly one group name that contains only abc, a pattern of ab* matches all group names that start with ab, and a pattern of * matches all group names.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of group names that this method returns. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort results. If the parameter is set to 0 there is no maximum and all results are returned.

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

      listMemberGroups

      Lists the groups that directly contain a user or a group. Returns a cursor (string).You can use methods from weblogic.management.utils.NameLister (which this MBean extends) to iterate through the returned list.

         
      Operation Name"listMemberGroups"
      ParametersObject [] {  memberUserOrGroupName }

      where:

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

        - The name of an existing user or group.

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

      listUsers

      Searches for a user name that matches a pattern.

      This method returns a cursor that you can pass to the methods from weblogic.management.utils.NameListerMBean (which this MBean extends) to iterate through the returned list.

      This method does not sort the results.

         
      Operation Name"listUsers"
      ParametersObject [] {  userNameWildcardmaximumToReturn }

      where:

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

        - The pattern for which this method searches. The pattern can end with an * (asterisk) as a wildcard, which matches any string of characters.

        For example, a pattern of abc matches exactly one user name that contains only abc, a pattern of ab* matches all user names that start with ab, and a pattern of * matches all user names.

      • maximumToReturn is an object of type java.lang.Integer that specifies:

        - The maximum number of user names that this method returns. If there are more matches than this maximum, then the returned results are arbitrary because this method does not sort results. If the parameter is set to 0 there is no maximum and all results are returned.

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

      removeGroup

      Removes a group. If the group contains members, the members are not removed.

         
      Operation Name"removeGroup"
      ParametersObject [] {  groupName }

      where:

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

        - The name of an existing group.

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

      removeMemberFromGroup

      Removes a user or group (member) from a group. If the member is not in the group, this method does nothing.

         
      Operation Name"removeMemberFromGroup"
      ParametersObject [] {  groupNamememberUserOrGroupName }

      where:

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

        - The name of an existing group from which this method removes a member.

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

        - The name of the member, which must be an existing user or group.

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

      removeUser

      Removes a user.

         
      Operation Name"removeUser"
      ParametersObject [] {  userName }

      where:

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

        - The name of an existing user.

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

      resetUserPassword

      Used by an administrator to change a user's password.

         
      Operation Name"resetUserPassword"
      ParametersObject [] {  userNamenewPassword }

      where:

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

        - The name of an existing user.

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

        - The new password for the user. The Authentication provider determines the syntax requirements for passwords.

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

      setGroupDescription

      Sets the description for an existing group.

         
      Operation Name"setGroupDescription"
      ParametersObject [] {  groupNamedescription }

      where:

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

        - The name of an existing group.

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

        - The description of the group.

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

      setUserDescription

      Sets the description for an existing user.

         
      Operation Name"setUserDescription"
      ParametersObject [] {  userNamedescription }

      where:

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

        - The name of an existing user.

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

        - The description of the user.

      SignatureString [] { "java.lang.String", "java.lang.String" }
      Returns void
      Exceptions
      • weblogic.management.utils.NotFoundException
      • 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.

      userExists

      Indicates whether the specified user exists.

         
      Operation Name"userExists"
      ParametersObject [] {  userName }

      where:

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

        - The name that this method evaluates.

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

      wls_getDisplayName

         
      Operation Name"wls_getDisplayName"
      Parametersnull
      Signaturenull
      ReturnsString