com.tivoli.pd.rgy
Interface RgyGroup

All Superinterfaces:

RgyEntity

public interface RgyGroup
extends RgyEntity

Provides methods specific to the SAM Group entity in addition to what is provided in the base Interface: RgyEntity. For groups this is just the ability to list and manipulate their members, and to import Native entities.

Multiple threads should not access the same instance of this interface at the same time.

Method Summary

void	addMembers(java.util.List<java.lang.String> memberIds) Adds users to the group.
void	importNativeGroup(java.lang.String groupId, RgyAttributes rgyAttributes) Adds the SAM layer to this Native group, making this Native group entity a SAM group entity.
java.util.Set<java.lang.String>	listMemberIds() Returns a Set of SAM user IDs for the group.
java.util.Set<java.lang.String>	listMemberNativeIds() Returns a Set of String Native IDs.
void	removeMembers(java.util.List<java.lang.String> memberIds) Removes users from the group.

Methods inherited from interface com.tivoli.pd.rgy.RgyEntity

attributeAdd, attributeAdd, attributeDelete, attributeDelete, attributeDelete, attributeNameIterator, attributeReplace, attributeReplace, getAttributeValues, getDomain, getId, getNativeId, getOneAttributeValue, getRgyRegistry

Method Detail

listMemberIds

java.util.Set<java.lang.String> listMemberIds()
                                              throws RgyException

Returns a Set of SAM user IDs for the group. Only SAM enabled user SAM IDs are returned.

Returns:

Set of String userIds

Throws:

RgyException

listMemberNativeIds

java.util.Set<java.lang.String> listMemberNativeIds()
                                                    throws RgyException

Returns a Set of String Native IDs. This Set may contain non-SAM members (Native only).

Returns:

Set of String Native IDs.

Throws:

RgyException

addMembers

void addMembers(java.util.List<java.lang.String> memberIds)
                throws RgyException

Adds users to the group.

Parameters:

memberIds - A List of SAM user ID Strings of the members to add.

Throws:

RgyException

removeMembers

void removeMembers(java.util.List<java.lang.String> memberIds)
                   throws RgyException

Removes users from the group.

Parameters:

memberIds - A List of SAM user ID Strings of the members to remove.

Throws:

RgyException

importNativeGroup

void importNativeGroup(java.lang.String groupId,
                       RgyAttributes rgyAttributes)
                       throws RgyException

Adds the SAM layer to this Native group, making this Native group entity a SAM group entity.

Parameters:

groupId - The SAM group SAM ID to give the imported entity, for example "testgroup".

rgyAttributes - A list of SAM entity attributes to create the SAM group entity with. Currently this does not support adding additional attributes to the Native user entity, and those will be ignored.

Throws:

RgyException