Package com.ibm.wsspi.security.wim.model

Class GroupMembershipControl

java.lang.Object
com.ibm.wsspi.security.wim.model.Control
com.ibm.wsspi.security.wim.model.PropertyControl
com.ibm.wsspi.security.wim.model.SearchControl
com.ibm.wsspi.security.wim.model.HierarchyControl
com.ibm.wsspi.security.wim.model.GroupControl
com.ibm.wsspi.security.wim.model.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.

    • Constructor Details

      • GroupMembershipControl

        public GroupMembershipControl()

    • Method Details

      • get

        public Object get(String propName)
        Gets the value of the requested property
        Overrides:
        get in class GroupControl
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is Object

      • isSet

        public boolean isSet(String propName)
        Returns true if the requested property is set; false, otherwise.
        Overrides:
        isSet in class GroupControl
        Returns:
        returned object is boolean

      • set

        public void set(String propName, Object value)
        Sets the value of the provided property to the provided value.
        Overrides:
        set in class GroupControl
        Parameters:
        propName - allowed object is String
        value - allowed object is Object

      • unset

        public void unset(String propName)
        Sets the value of provided property to null.
        Overrides:
        unset in class GroupControl
        Parameters:
        propName - allowed object is String

      • getTypeName

        public String getTypeName()
        Gets the name of this model object, GroupMembershipControl
        Overrides:
        getTypeName in class GroupControl
        Returns:
        returned object is String

      • getPropertyNames

        public static List getPropertyNames(String entityTypeName)
        Gets a list of all supported properties for this model object, GroupMembershipControl
        Parameters:
        entityTypeName - allowed object is String
        Returns:
        returned object is List

      • getDataType

        public String getDataType(String propName)
        Gets the Java type of the value of the provided property. For example: String, List
        Overrides:
        getDataType in class GroupControl
        Parameters:
        propName - allowed object is String
        Returns:
        returned object is String

      • getSuperTypes

        public ArrayList getSuperTypes()
        Gets a list of any model objects which this model object, GroupMembershipControl, is an extension of.
        Overrides:
        getSuperTypes in class GroupControl
        Returns:
        returned object is ArrayList

      • isSubType

        public boolean isSubType(String superTypeName)
        Returns a true if the provided model object is one that this model object extends; false, otherwise.
        Overrides:
        isSubType in class GroupControl
        Parameters:
        superTypeName - allowed object is String
        Returns:
        returned object is boolean

      • getSubTypes

        public static HashSet getSubTypes()
        Gets a set of any model objects which extend this model object, GroupMembershipControl
        Returns:
        returned object is HashSet

      • toString

        public String toString()
        Returns this model object, GroupMembershipControl, and its contents as a String
        Overrides:
        toString in class GroupControl
        Returns:
        returned object is String