Oracle

weblogic.management.security.authentication
Interface GroupUserListerMBean

All Superinterfaces:
GroupReaderMBean, ListerMBean, NameListerMBean

public interface GroupUserListerMBean
extends GroupReaderMBean

Provides a method for listing a group's user members. 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.

Deprecation of MBeanHome and Type-Safe Interfaces

In addition to being used as a base class that provides functionality to security provider MBeans, JMX applications can use this class directly as a type-safe interface. When used as a type-safe interface, a JMX application imports this class and accesses it through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, JMX applications that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime.


Method Summary
 String[] listAllUsersInGroup(String groupName, String userNameWildcard, int maximumToReturn)
          Searches within a group for user (member) names that match a pattern.
 
Methods inherited from interface weblogic.management.security.authentication.GroupReaderMBean
getGroupDescription, groupExists, isMember, listGroups
 
Methods inherited from interface weblogic.management.utils.NameListerMBean
getCurrentName
 
Methods inherited from interface weblogic.management.utils.ListerMBean
advance, close, haveCurrent
 

Method Detail

listAllUsersInGroup

String[] listAllUsersInGroup(String groupName,
                             String userNameWildcard,
                             int maximumToReturn)
                             throws NotFoundException,
                                    InvalidParameterException
Searches within a group for user (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 names.

Parameters:
groupName - - The existing group within which this method searches for members.
userNameWildcard - - 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 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 - - 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 this parameter is set to 0, all results are returned.
Throws:
NotFoundException
InvalidParameterException

Documentation is available at
http://download.oracle.com/docs/cd/E12839_01/web.1111
Copyright 1996,2009, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Part Number E13941-01
Oracle WebLogic Server 10.3.1 API Reference