GroupReaderMBean (Abstract)

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Provides a set of methods for reading data about groups. 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 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.GroupReaderMBean
   
Factory Methods No factory methods. Instances of this MBean are created automatically.    
Subtypes The following MBeans extend or implement this MBean type:

Operations

This section describes the following operations:

 

advance

Advances the list to the next element in the list.

Operation Name "advance"    
Parameters Object [] {  cursor }

where:

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

    - The cursor returned from a previous list method.

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

  • weblogic.management.utils.InvalidCursorException

 

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"    
Parameters Object [] {  cursor }

where:

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

    - The cursor returned from a previous list method.

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

  • weblogic.management.utils.InvalidCursorException

 

getCurrentName

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

Operation Name "getCurrentName"    
Parameters Object [] {  cursor }

where:

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

    - The cursor returned from a previous list method.

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

  • weblogic.management.utils.InvalidCursorException

 

getGroupDescription

Gets a group's description.

Operation Name "getGroupDescription"    
Parameters Object [] {  groupName }

where:

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

    - The name of an existing group.

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

  • weblogic.management.utils.NotFoundException

  • weblogic.management.utils.InvalidParameterException

 

groupExists

Indicates whether the specified group exists.

Operation Name "groupExists"    
Parameters Object [] {  groupName }

where:

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

    - The name that this method evaluates.

Signature String [] { "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"    
Parameters Object [] {  cursor }

where:

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

    - The cursor returned from a previous list method.

Signature String [] { "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"    
Parameters Object [] {  parentGroupName, memberUserOrGroupName, recursive }

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.

Signature String [] { "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"    
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

 

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"    
Parameters Object [] {  groupNameWildcard, maximumToReturn }

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. The search is not case-sensitive.

    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.

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

  • weblogic.management.utils.InvalidParameterException

 

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