com.sun.identity.um
Class DynamicGroup

java.lang.Object
  |
  +--com.sun.identity.um.Common
        |
        +--com.sun.identity.um.DynamicGroup

public final class DynamicGroup
extends Common

The DynamicGroup interface provides methods to manage dynamic group


Method Summary
 java.lang.String getFilter()
          Gets the search filter for the dynamic group.
 long getNumberOfUsers()
          Gets number of users in the group.
 java.util.Set getUserDNs()
          Gets the DNs of users in the group.
 java.util.Set searchUsers(java.lang.String wildcard)
          Searches for users in this group using wildcards and attribute values.
 void setFilter(java.lang.String filter)
          Sets the search filter for the dynamic group.
 
Methods inherited from class com.sun.identity.um.Common
assignServices, delete, delete, getAssignedServices, getAttributes, getAttributes, getDN, getOrganizationDN, getParentDN, getServiceAttributes, getServiceStatus, isExists, modifyService, removeAttributes, setAttributes, setServiceStatus, store, unassignServices
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getNumberOfUsers

public long getNumberOfUsers()
                      throws UMException,
                             SSOException
Gets number of users in the group.
Returns:
Number of users in the group.
Throws:
UMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid

getUserDNs

public java.util.Set getUserDNs()
                         throws UMException,
                                SSOException
Gets the DNs of users in the group.
Returns:
The names of users' DNs in the group.
Throws:
UMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid

searchUsers

public java.util.Set searchUsers(java.lang.String wildcard)
                          throws UMException,
                                 SSOException
Searches for users in this group using wildcards and attribute values. Wildcards can be specified such as a*, *, *a.
Parameters:
wildcard - wildcard pattern to be used in the search
Returns:
Set of DNs of Users matching the search
Throws:
UMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid

getFilter

public java.lang.String getFilter()
                           throws UMException,
                                  SSOException
Gets the search filter for the dynamic group.
Returns:
The filter in LDIF format for the dynamic group.
Throws:
UMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid

setFilter

public void setFilter(java.lang.String filter)
               throws UMException,
                      SSOException
Sets the search filter for the dynamic group.
Returns:
The filter in LDIF format for the dynamic group.
Throws:
UMException - if an error is encountered when trying to access/retrieve data from the data store
SSOException - if the sign on is no longer valid