Class GroupMembershipControl


  • public class GroupMembershipControl
    extends GroupControl

    Java class for GroupMembershipControl complex type.

    The following schema fragment specifies the expected content contained within this class.

     <complexType name="GroupMembershipControl">
     <complexContent>
     <extension base="{http://www.ibm.com/websphere/wim}GroupControl">
     </extension>
     </complexContent>
     </complexType>
     

    The GroupMembershipControl object extends from the abstract GroupControl object.

    The GroupControl DataObject contains the following properties that are inherited by GroupMembershipControl: level, properties, searchBases, countLimit, timeLimit, modifyMode and expression.

    GroupMembershipControl is used in the input Root object of both the get() API and update() API.

    In the get() API, GroupMembershipControl is used for requesting the groups to which an entity belongs. If theGroupMembershipControl is added to the input Root object, then the groups the entity belongs to will be returned.

    GroupMembershipControl can also be used for specifying the properties to be returned for groups as well as the level of nested groups to be returned.

    • level
      • 0: will return all nested groups
      • 1: will cause only the immediate groups to be returned. This is the default value.
      • greater than 1: will return the specified level number of groups. For example, a level of 2 will return immediate groups and their immediate groups.

    In an update() API call, GroupMembershipControl can be used to specify the assign or un-assign mode through the modifyMode property.

    • modifyMode
      • 1: the groups contained in the entity object will add the entity as their members. This is the default setting.
      • 2: the groups contained in the entity object will add the entity as their members and all the existing members will be removed.
      • 3: the groups contained in the entity object will remove the entity from their members.

    Since GroupMembershipControl is also extended from SearchControl, you can specify property expression and other search properties like countLimit, and timeLimit in GroupMembershipControl to only return those groups which satisfy the search criteria. For example, it is possible to add the property expression with value: @xsi:type='Group' and cn='Admin*' to only return those groups whose cn property starts with Admin.

  • treeView: used to indicate whether the hierarchy of the nested groups should be kept in the output Root object or not. If it is set to true, the hierarchy relationship of the immediate groups and nested groups of different levels are kept in the Root object. If it is set to false, all groups are put in a flat structure by pointing to the same groups property of the entity.