com.hyperion.css.common
Interface CSSGroupIF

All Superinterfaces:

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

All Known Subinterfaces:

CSSNativeGroupIF

public interface CSSGroupIF
extends com.hyperion.css.cache.CacheNodeIF, java.io.Serializable

This represents a group in the security platform and the directories.

Except for getGroupList()and getUserList(), the method invocations do not lead to a query to the directory. All other data is statically constructed during the creation of this instance.

Defintion of terms utilized in the documentation:

1. Direct Association: Implies that there is a direct association with this group.
2. Indirect Association: Implies that an entity is associated with this group through a sequence of groups where this sequence is greater or equal to one.

There are no methods to return the roles for this group as that is not required.

Since:

CSSv2.0

Author:

gkhanna

See Also:

com.hyperion.css.CSSUserProvisioningAPIIF#getRolesForGroupInProject(Map, CSSPrincipalIF, String, String, boolean)

Method Summary

com.hyperion.css.common.CSSApplicationEntry[]	getAllRolesList(java.util.Map context, CSSPrincipalIF principal) Deprecated. - Use CSSUserProvisioningAPIIF.getRolesListForEntry(Map, CSSPrincipalIF, String, String[], boolean)
java.lang.String	getDescription() Gets the description for this group.
java.util.Map	getGroupInfo() This is an EPM mode only API.
java.lang.String[]	getGroupList() Deprecated. Use getGroupList(CSSPrincipalIF, boolean) instead. This is an EPM mode only API.
java.lang.String[]	getGroupList(CSSPrincipalIF principal, boolean returnIndirect) This is an EPM mode only API.
com.hyperion.css.cache.CacheNodeIF[]	getGroupsTree(CSSPrincipalIF principal, boolean indirect) This is an EPM mode only API.
java.lang.String	getIdentity() Gets the identity for this group.
java.lang.String	getName() Gets the name for this group.
java.lang.String[]	getParentGroups(CSSPrincipalIF principal, boolean returnIndirect) This is an EPM mode only API.
java.lang.String[]	getRolesList(CSSPrincipalIF principal, java.lang.String appId, boolean returnIndirect) This is an EPM mode only API.
java.lang.String[]	getUserList() Deprecated. Use getUsersList(CSSPrincipalIF, boolean) instead. This is an EPM mode only API.
java.lang.String[]	getUsersList(CSSPrincipalIF principal, boolean returnIndirect) Deprecated. - Use getUsersList(Map, CSSPrincipalIF, boolean).
java.lang.String[]	getUsersList(java.util.Map context, CSSPrincipalIF principal, boolean returnIndirect) This is an EPM mode only API.

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

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

Method Detail

getIdentity

java.lang.String getIdentity()

Gets the identity for this group.

Specified by:

getIdentity in interface com.hyperion.css.cache.CacheNodeIF

Returns:

String

getName

java.lang.String getName()

Gets the name for this group.

Specified by:

getName in interface com.hyperion.css.cache.CacheNodeIF

Returns:

String

getDescription

java.lang.String getDescription()

Gets the description for this group.

Specified by:

getDescription in interface com.hyperion.css.cache.CacheNodeIF

Returns:

String

getUserList

@Deprecated
java.lang.String[] getUserList()
                               throws CSSCommunicationException,
                                      CSSException

Deprecated. Use getUsersList(CSSPrincipalIF, boolean) instead. This is an EPM mode only API.

Throws:

CSSCommunicationException

CSSException

getGroupList

@Deprecated
java.lang.String[] getGroupList()
                                throws CSSCommunicationException,
                                       CSSException

Deprecated. Use getGroupList(CSSPrincipalIF, boolean) instead. This is an EPM mode only API.

Throws:

CSSCommunicationException

CSSException

getGroupInfo

java.util.Map getGroupInfo()
                           throws CSSException

This is an EPM mode only API.

Gets the provider-specific attributes. The provider can return a map of attributes as key-value pairs.

This map should contain the key CSSAPIIF.PROVIDER_REQUESTand the value should be the URL or the domain name of the server where this group entry was looked up (server of reference).

Returns:

Map

Throws:

CSSMethodNotSupportedException - - if this method is not supported for a particular CSS mode.

CSSException - - if there was any other abnormality

getParentGroups

java.lang.String[] getParentGroups(CSSPrincipalIF principal,
                                   boolean returnIndirect)
                                   throws CSSCommunicationException,
                                          CSSException

This is an EPM mode only API.

Returns the parent groups. The complete list of parent groups is returned.

This method has the ability to return both the direct and indirect associations. Please note that a query for indirect associations might be resource heavy and it is recommended to cache the results. Please note that if there is a circular dependency, then only a single identity is returned.

Parameters:

principal - The caller invoking this method.

returnIndirect - If true then the indirect associations are also returned.

Returns:

String [] Empty if there are no parent groups. If there are parents, then the unique identities are returned.

Throws:

CSSException - If there is any abnormality.

CSSCommunicationException

Since:

CSS v3.0

getUsersList

@Deprecated
java.lang.String[] getUsersList(CSSPrincipalIF principal,
                                           boolean returnIndirect)
                                throws CSSCommunicationException,
                                       CSSException

Deprecated. - Use getUsersList(Map, CSSPrincipalIF, boolean).

Throws:

CSSCommunicationException

CSSException

getGroupList

java.lang.String[] getGroupList(CSSPrincipalIF principal,
                                boolean returnIndirect)
                                throws CSSCommunicationException,
                                       CSSException

This is an EPM mode only API.

Gets the sub-groups (child groups) of this group. The complete list of child groups is returned.

If there is an exception, this method can be called and the instance is not destroyed.

The method returns direct as well as indirect associations.

Parameters:

principal - The caller invoking this method.

returnIndirect - If true then the indirect associations are also returned.

Returns:

String [] Empty if this group does not have any member groups or the principal does not have access. If the group has member groups, the string returned is an array of identities.

Throws:

CSSException - If there is any abnormality.

CSSCommunicationException

Since:

CSS v3.0

getRolesList

java.lang.String[] getRolesList(CSSPrincipalIF principal,
                                java.lang.String appId,
                                boolean returnIndirect)
                                throws CSSAuthorizationException,
                                       CSSCommunicationException,
                                       CSSException

This is an EPM mode only API.

Returns the roles associated with this group. The complete list of roles that this group is assigned to is returned.

This method returns the roles associated to this group directly or through indirect association. This behavior is governed by the indirect parameter. Aggregate roles are also returned along with its constituents.

The Hyperion Shared Services Global roles are returned in both the cases. Instances of Shared Services Global Roles are "Directory Manager", "Provisioning Manager" etc.

Parameters:

principal - The caller invoking this method.

appId - The unique identifier of the application instance.

returnIndirect - If true then returns the roles associated to the group directly or indirectly through association with parent groups. If false then only roles granted directly to the group are returned.

Returns:

Array of identities for the roles

Throws:

CSSAuthorizationException - If the principal does not have VIEW on the user or the project that the application is contained in.

CSSException - Any other abnormality.

CSSCommunicationException

Since:

CSS v3.0

getUsersList

java.lang.String[] getUsersList(java.util.Map context,
                                CSSPrincipalIF principal,
                                boolean returnIndirect)
                                throws CSSCommunicationException,
                                       CSSException

This is an EPM mode only API.

This method is not available for Joyce.

Gets the users that belong to this group. The complete list of users for that belong to this group is returned.

This method is similar to getUsersList(CSSPrincipalIF, boolean) except that is allows an option to return deactivated users as well.

The context can specify the following:

1. return deactivated users
2. locale

To express interest in returning deactivated users, please specify the key: CSSAPIIF.ENTITY_DEACTIVATE. This results in the return of deactivated users along with the active users as well.

If there is an exception, this method can be called and the instance is not destroyed.

The method returns direct as well as indirect associations.

Parameters:

principal - The caller invoking this method.

returnIndirect - If true then the indirect associations are also returned.

Returns:

String [] Empty if this group does not have any users or the principal does not have access. If the group has users, the string returned is an array of identities.

Throws:

CSSException - If there is any abnormality.

CSSCommunicationException

Since:

CSS v3.0

getAllRolesList

@Deprecated
com.hyperion.css.common.CSSApplicationEntry[] getAllRolesList(java.util.Map context,
                                                                         CSSPrincipalIF principal)
                                                              throws CSSException

Deprecated. - Use CSSUserProvisioningAPIIF.getRolesListForEntry(Map, CSSPrincipalIF, String, String[], boolean)

Throws:

CSSException

getGroupsTree

com.hyperion.css.cache.CacheNodeIF[] getGroupsTree(CSSPrincipalIF principal,
                                                   boolean indirect)
                                                   throws CSSAuthorizationException,
                                                          CSSCommunicationException,
                                                          CSSException

This is an EPM mode only API.

Returns an array of CacheNodeIF depending on the group association for a group. The parents of the group can be obtained by invoking the getNextLevel().

This method returns both the direct and indirect associations depending on the value of the indirect flag specified. Please note that this query might be resource heavy, hence it is recommended to cache the results when you require a recursive group list.

Parameters:

principal - The identity of the caller. The reason for specifying this argument here is that there is an associated method for CSS v2.0. The principal has an effect on the outcome of the results of this call.

indirect - true or false. True fetches indirectly associated parents.

Returns:

CacheNodeIF[] Groups that this user belongs to.

Throws:

CSSAuthorizationException - Returned if the principal does not have VIEW on the user or the project in which the application is contained.

CSSException - Any other abnormality.

CSSCommunicationException

Since:

CSS v3.0