com.hyperion.css.common
Interface CSSNativeGroupIF

All Superinterfaces:

com.hyperion.css.cache.CacheNodeIF, CSSGroupIF, java.io.Serializable

public interface CSSNativeGroupIF
extends CSSGroupIF

This interface provided the functionality for creating and managing groups in the native directory.

Since:

CSS 3.0

Author:

gkhanna

See Also:

CSSGroupIF

Method Summary

java.lang.String[]	getSetGroupList() For Internal Use Only
java.lang.String[]	getSetParentGroups() For Internal Use Only
java.lang.String[]	getSetUserList() For Internal Use Only
void	removeFromParentGroups(CSSPrincipalIF principal, java.lang.String[] groups) Removes the group from its parent groups.
void	removeGroupList(CSSPrincipalIF principal, java.lang.String[] groups) Removes group members from a group.
void	removeUserList(CSSPrincipalIF principal, java.lang.String[] users) Removes user members from the group.
void	setDescription(java.lang.String description) Sets the description of the group.
void	setGroupInfo(java.util.Map info) For Internal Use Only
void	setGroupList(java.lang.String[] groups, boolean add) Assigns the following groups as members of this group.
void	setName(java.lang.String name) Sets the name of the group.
void	setParentGroups(java.lang.String[] groups, boolean add) Assigns this group as a member of the specified groups.
void	setUserList(java.lang.String[] users, boolean add) Sets the users list for this group.

Methods inherited from interface com.hyperion.css.common.CSSGroupIF

getAllRolesList, getDescription, getGroupInfo, getGroupList, getGroupList, getGroupsTree, getIdentity, getName, getParentGroups, getRolesList, getUserList, getUsersList, getUsersList

Methods inherited from interface com.hyperion.css.cache.CacheNodeIF

clear, getIdentifier, getMembers, getParentGroups, getPrimaryGroupToken, getProviderName, isGroup

Method Detail

setName

void setName(java.lang.String name)

Sets the name of the group.

Parameters:

name - - name for the group

setDescription

void setDescription(java.lang.String description)

Sets the description of the group.

Parameters:

description - - description for the group

setUserList

void setUserList(java.lang.String[] users,
                 boolean add)
                 throws CSSCommunicationException,
                        CSSException

Sets the users list for this group. Please note that the users for this group can either stem from the native directory or the corporate directory.

Parameters:

users - - the array of unique identities of the users.

add - - if true then the users are added to the existing users. Otherwise the existing users are replaced

Throws:

CSSException - - if there is any abnormality.

CSSCommunicationException

getSetUserList

java.lang.String[] getSetUserList()
                                  throws CSSCommunicationException,
                                         CSSException

For Internal Use Only

Throws:

CSSCommunicationException

CSSException

setGroupList

void setGroupList(java.lang.String[] groups,
                  boolean add)
                  throws CSSCommunicationException,
                         CSSCircularDependencyException,
                         CSSException

Assigns the following groups as members of this group.

This method denies any assignment that would lead to a circular dependency. If any of the parent groups are either directly or indirectly associated with this group as a parent or as a child then this method would fail with a CSSCircularDependecyException.

Please note that there would be no duplicate group membership persisted even if it is passed in the groups argument.

Parameters:

groups - - the list of member groups

add - - if true then the groups are added to the existing groups. Otherwise, the existing groups are replaced.

Throws:

CSSCircularDependencyException - - if a circular dependency is detected then this exception is thrown.

CSSException - - if there is any other abnormality.

CSSCommunicationException

getSetGroupList

java.lang.String[] getSetGroupList()
                                   throws CSSCommunicationException,
                                          CSSException

For Internal Use Only

Throws:

CSSCommunicationException

CSSException

setParentGroups

void setParentGroups(java.lang.String[] groups,
                     boolean add)
                     throws CSSCircularDependencyException,
                            CSSCommunicationException,
                            CSSException

Assigns this group as a member of the specified groups.

This method denies any assignment that would lead to a circular dependency. If any of the parent groups are either directly or indirectly associated with this group as a parent or as a child then this method would fail with a CSSCircularDependecyException.

Parameters:

groups - - the list of parents.

add - - if true then the groups are added to the existing groups. Otherwise, the existing groups are replaced

Throws:

CSSCircularDependencyException - - if a circular dependency is detected then this exception is thrown.

CSSException - - if there is any other abnormality.

CSSCommunicationException

getSetParentGroups

java.lang.String[] getSetParentGroups()

For Internal Use Only

setGroupInfo

void setGroupInfo(java.util.Map info)

For Internal Use Only

removeGroupList

void removeGroupList(CSSPrincipalIF principal,
                     java.lang.String[] groups)
                     throws CSSIllegalArgumentException,
                            CSSInvalidIdentityException,
                            CSSInvalidGroupException,
                            CSSOperationNotSupportedException,
                            CSSException

Removes group members from a group.

This removes group members from the group on which the call is invoked. The group members to be removed are passed as an argument. The method removes the groups with direct association. If null value or empty string array is passed for groups the method stops further operations. Throws CSSOperationNotSupportedException if WORLD group identity is passed.

Parameters:

principal - - the logged in user principal.

groups - - the array of group member identities to be removed. Throws CSSInvalidIdentityException in case one of the identities is invalid.

Throws:

- - CSSIllegalArgumentException if principal is null CSSInvalidIdentityException for invalid identity string. CSSInvalidGroupException if identity doesn't exist. CSSOperationNotSupportedException - If world group Identity is passed. CSSException - catches if there is any abnormality and continues.

CSSIllegalArgumentException

CSSInvalidIdentityException

CSSInvalidGroupException

CSSOperationNotSupportedException

CSSException

removeUserList

void removeUserList(CSSPrincipalIF principal,
                    java.lang.String[] users)
                    throws CSSIllegalArgumentException,
                           CSSInvalidIdentityException,
                           CSSInvalidUserException,
                           CSSException

Removes user members from the group.

This removes user members from the group on which the call is invoked. The user members to be reomved are passed as an argument. The method removes users with direct association. If null value or empty string array is passed for users stops further operations.

Parameters:

principal - - the logged in user principal.

users - - the array of user member identities to be removed. Throws CSSInvalidIdentityException in case one of the identities is invalid.

Throws:

- - CSSIllegalArgumentException if principal is null CSSInvalidIdentityException for invalid identity string. CSSInvalidUserException if identity doesn't exist. CSSException - catches if there is any abnormality and

CSSIllegalArgumentException

CSSInvalidIdentityException

CSSInvalidUserException

CSSException

removeFromParentGroups

void removeFromParentGroups(CSSPrincipalIF principal,
                            java.lang.String[] groups)
                            throws CSSIllegalArgumentException,
                                   CSSInvalidIdentityException,
                                   CSSInvalidGroupException,
                                   CSSOperationNotSupportedException,
                                   CSSException

Removes the group from its parent groups.

Removes the group from its parent groups. The group to be removed is the one on which call is invoked. Parent group identities are passed as an argument. These identities should be directly associated with the group which is to be removed. If null value or empty array is passed, the method stops further operations. External identities should not be passed. If so then it logs warning and continues with rest of the identities. Throws CSSOperationNotSupportedException if WORLD group identity is passed.

Parameters:

principal - - the logged in user principal.

groups - - the array of parent group identities to be removed.

Throws:

- - CSSIllegalArgumentException if principal is null CSSInvalidIdentityException for invalid identity string. CSSInvalidGroupException if identity doesn't exist. CSSOperationNotSupportedException - If world group Identity is passed. CSSException - catches if there is any abnormality and continues.

CSSIllegalArgumentException

CSSInvalidIdentityException

CSSInvalidGroupException

CSSOperationNotSupportedException

CSSException