com.hyperion.css.common
Interface CSSLoginUserIF

All Superinterfaces:

java.io.Serializable

public interface CSSLoginUserIF
extends java.io.Serializable

This represents a user object with groups and roles belonging to the user. This object is used from CSSAPIIF.login API and CSS clients use it at user login time.

Since:

CSSv2.0

Author:

Sang

Method Summary

java.lang.String[]	getGroupsList() Returns list of groups for the specified applications for the User.
java.lang.String[]	getGroupsList(java.lang.String applicationId) Returns an array of group identities that the user belongs to and were directly or indirectly provisioned to the specified application.
java.lang.String[]	getRolesForGroup(java.lang.String groupIdentity, java.lang.String applicationId) Returns an array of role identities that were directly or indirectly provisioned to the specified group (group identity should be one of the group identity returned in getGroupsList API) for the specified application.
java.lang.String[]	getRolesList() Returns list of Roles for the specified applications for the User.
java.lang.String[]	getRolesList(java.lang.String applicationId) Returns an array of role identities that were directly or indirectly provisioned to the user for the specified application.
CSSUserIF	getUser() Gets the user object of this user.

Method Detail

getUser

CSSUserIF getUser()

Gets the user object of this user.

Returns:

CSSUserIF

getGroupsList

java.lang.String[] getGroupsList()

Returns list of groups for the specified applications for the User.

In Fusion Mode: Returns an array of EnterpriseRoles/Groups that user belongs to directly or indirectly. All the EnterpriseRoles populated in the Authenticated JPS Subject are returned as Groups.

Returns:

String[] - empty if there are no groups for this user.

getRolesList

java.lang.String[] getRolesList()

Returns list of Roles for the specified applications for the User.

Returns:

String[] - empty if there are no roles for this user.

getGroupsList

java.lang.String[] getGroupsList(java.lang.String applicationId)

Returns an array of group identities that the user belongs to and were directly or indirectly provisioned to the specified application. An empty array will be returned if no groups were provisioned to the specified application.

In Fusion Mode: Returns an array of EnterpriseRoles/Groups that user belongs to directly or indirectly. Fusion Application ID is ignored in computing User Groups. All the EnterpriseRoles populated in the Authenticated JPS Subject are returned as Groups.

Parameters:

applicationId -

Returns:

array of groups identities.

getRolesList

java.lang.String[] getRolesList(java.lang.String applicationId)

Returns an array of role identities that were directly or indirectly provisioned to the user for the specified application. An empty array will be returned if no roles were provisioned for the user to the specified application.

Parameters:

applicationId -

Returns:

array of role identities.

getRolesForGroup

java.lang.String[] getRolesForGroup(java.lang.String groupIdentity,
                                    java.lang.String applicationId)

Returns an array of role identities that were directly or indirectly provisioned to the specified group (group identity should be one of the group identity returned in getGroupsList API) for the specified application. An empty array will be returned if no roles were provisioned for the specified group in specified application.

This is a EPM Mode Only API