com.hyperion.css
Interface CSSWebAPIIF

public interface CSSWebAPIIF

This interface contains all the API's needed for the HSS UI.

Method Summary

com.hyperion.css.common.CSSApplicationEntry[]	getAllProvisionedAppsWithRoles(java.util.Map context, CSSPrincipalIF principal, java.lang.String identity, java.util.Map<java.lang.String,com.hyperion.css.spi.impl.nvdb.NativeRoleImpl> allRolesMap) This API is responsible to get all the provisioned applications for the given entry.
java.util.Set<com.hyperion.css.spi.impl.nvdb.NativeRoleImpl>	getAllRoles(java.util.Map context, CSSPrincipalIF principal)
CSSApplicationInstance	getApplicationInstance(java.util.Map context, CSSPrincipalIF principal, java.lang.String applicationId) Returns the application instance for the specified application id.
java.lang.String[]	getDelegatedEntries(java.util.Map context, CSSPrincipalIF principal, java.lang.String[] array)
CSSDelegatedListIF[]	getDelegatedLists(java.util.Map context, CSSPrincipalIF principal, java.util.Set<java.lang.String> identities, boolean isDA)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForAllGroups(java.util.Map context, CSSPrincipalIF principal, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForAllUsers(java.util.Map context, CSSPrincipalIF principal, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForGroups(java.util.Map context, CSSPrincipalIF principal, java.lang.String groupFilter, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForGroupsWithRoles(java.util.Map context, CSSPrincipalIF principal, java.util.Set<java.lang.String> roleIdentities, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForGroupsWithRoles(java.util.Map context, CSSPrincipalIF principal, java.lang.String roleFilter, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForUserIdentities(java.util.Map context, CSSPrincipalIF principal, java.util.Set<java.lang.String> userIdentities, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForUsers(java.util.Map context, CSSPrincipalIF principal, java.lang.String userFilter, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForUsersWithRoles(java.util.Map context, CSSPrincipalIF principal, java.util.Set<java.lang.String> roleIdentities, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>>	getProvisioningReportForUsersWithRoles(java.util.Map context, CSSPrincipalIF principal, java.lang.String roleFilter, java.util.Set<java.lang.String> applicationIds, boolean indirect)
java.util.Set	getRoleListWithHiearchy(java.util.Map context, CSSPrincipalIF principal, java.util.Set identities, java.util.Set applicationIds, boolean indirect, int i)
java.util.Map	getRolesWithHierarchyForApplications(java.util.Map context, CSSPrincipalIF principal, java.util.ArrayList<CSSApplicationInstance> appInstances, java.util.Set<com.hyperion.css.spi.impl.nvdb.NativeRoleImpl> allRolesSet) This API is responsible to build the roles with hierarchy for the application.
boolean	hasHUBRole(java.util.Map context, CSSPrincipalIF principal, CSSUserIF user) This API is responsible to validate the specified identity got any roles on HUB application either directly or indirectly.
boolean	isAdministrator(java.util.Map context, CSSPrincipalIF principal, java.lang.String userIdentity) This API is responsible to validate the specified identity got Administrator role on HUB application either directly or indirectly.
boolean	isDelegatedModeON()
java.util.ArrayList	refineList(java.util.ArrayList arrayList, java.util.ArrayList availableIds)

Method Detail

isAdministrator

boolean isAdministrator(java.util.Map context,
                        CSSPrincipalIF principal,
                        java.lang.String userIdentity)
                        throws CSSException

This API is responsible to validate the specified identity got Administrator role on HUB application either directly or indirectly.

Parameters:

context -

principal -

userIdentity -

Returns:

- true, if the specified identity got CSSAPIIF.ROLE_ADMINISTRATOR_IDENTITY

Throws:

CSSException

hasHUBRole

boolean hasHUBRole(java.util.Map context,
                   CSSPrincipalIF principal,
                   CSSUserIF user)
                   throws CSSException

This API is responsible to validate the specified identity got any roles on HUB application either directly or indirectly.

Parameters:

context -

principal -

user -

Returns:

Throws:

CSSException

getApplicationInstance

CSSApplicationInstance getApplicationInstance(java.util.Map context,
                                              CSSPrincipalIF principal,
                                              java.lang.String applicationId)
                                              throws CSSException

Returns the application instance for the specified application id.

Parameters:

context -

principal -

applicationId -

Returns:

- null, will be returned if application not found in the system.

Throws:

CSSException

getRolesWithHierarchyForApplications

java.util.Map getRolesWithHierarchyForApplications(java.util.Map context,
                                                   CSSPrincipalIF principal,
                                                   java.util.ArrayList<CSSApplicationInstance> appInstances,
                                                   java.util.Set<com.hyperion.css.spi.impl.nvdb.NativeRoleImpl> allRolesSet)
                                                   throws CSSException

This API is responsible to build the roles with hierarchy for the application. it will be used in provisioning screen.

Parameters:

context -

principal -

appInstances -

allRolesSet - TODO

Returns:

Throws:

CSSException

getAllProvisionedAppsWithRoles

com.hyperion.css.common.CSSApplicationEntry[] getAllProvisionedAppsWithRoles(java.util.Map context,
                                                                             CSSPrincipalIF principal,
                                                                             java.lang.String identity,
                                                                             java.util.Map<java.lang.String,com.hyperion.css.spi.impl.nvdb.NativeRoleImpl> allRolesMap)
                                                                             throws CSSException

This API is responsible to get all the provisioned applications for the given entry.

Parameters:

context -

principal -

identity -

allRolesMap - TODO

Returns:

Throws:

CSSException

getDelegatedLists

CSSDelegatedListIF[] getDelegatedLists(java.util.Map context,
                                       CSSPrincipalIF principal,
                                       java.util.Set<java.lang.String> identities,
                                       boolean isDA)
                                       throws CSSException

Throws:

CSSException

refineList

java.util.ArrayList refineList(java.util.ArrayList arrayList,
                               java.util.ArrayList availableIds)

Parameters:

arrayList -

availableIds -

Returns:

getRoleListWithHiearchy

java.util.Set getRoleListWithHiearchy(java.util.Map context,
                                      CSSPrincipalIF principal,
                                      java.util.Set identities,
                                      java.util.Set applicationIds,
                                      boolean indirect,
                                      int i)
                                      throws CSSException

Parameters:

context -

principal -

identities -

applicationIds -

indirect -

i -

Returns:

Throws:

CSSException

getDelegatedEntries

java.lang.String[] getDelegatedEntries(java.util.Map context,
                                       CSSPrincipalIF principal,
                                       java.lang.String[] array)
                                       throws CSSException

Parameters:

context -

principal -

array -

Returns:

Throws:

CSSException

isDelegatedModeON

boolean isDelegatedModeON()
                          throws CSSException

Returns:

Throws:

CSSException

getProvisioningReportForAllUsers

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForAllUsers(java.util.Map context,
                                                                                                                              CSSPrincipalIF principal,
                                                                                                                              java.util.Set<java.lang.String> applicationIds,
                                                                                                                              boolean indirect)
                                                                                                                              throws CSSException

Throws:

CSSException

getProvisioningReportForAllGroups

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForAllGroups(java.util.Map context,
                                                                                                                               CSSPrincipalIF principal,
                                                                                                                               java.util.Set<java.lang.String> applicationIds,
                                                                                                                               boolean indirect)
                                                                                                                               throws CSSException

Throws:

CSSException

getProvisioningReportForUsers

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForUsers(java.util.Map context,
                                                                                                                           CSSPrincipalIF principal,
                                                                                                                           java.lang.String userFilter,
                                                                                                                           java.util.Set<java.lang.String> applicationIds,
                                                                                                                           boolean indirect)
                                                                                                                           throws CSSException

Throws:

CSSException

getProvisioningReportForGroups

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForGroups(java.util.Map context,
                                                                                                                            CSSPrincipalIF principal,
                                                                                                                            java.lang.String groupFilter,
                                                                                                                            java.util.Set<java.lang.String> applicationIds,
                                                                                                                            boolean indirect)
                                                                                                                            throws CSSException

Throws:

CSSException

getProvisioningReportForUsersWithRoles

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForUsersWithRoles(java.util.Map context,
                                                                                                                                    CSSPrincipalIF principal,
                                                                                                                                    java.lang.String roleFilter,
                                                                                                                                    java.util.Set<java.lang.String> applicationIds,
                                                                                                                                    boolean indirect)
                                                                                                                                    throws CSSException

Throws:

CSSException

getProvisioningReportForGroupsWithRoles

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForGroupsWithRoles(java.util.Map context,
                                                                                                                                     CSSPrincipalIF principal,
                                                                                                                                     java.lang.String roleFilter,
                                                                                                                                     java.util.Set<java.lang.String> applicationIds,
                                                                                                                                     boolean indirect)
                                                                                                                                     throws CSSException

Throws:

CSSException

getProvisioningReportForUserIdentities

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForUserIdentities(java.util.Map context,
                                                                                                                                    CSSPrincipalIF principal,
                                                                                                                                    java.util.Set<java.lang.String> userIdentities,
                                                                                                                                    java.util.Set<java.lang.String> applicationIds,
                                                                                                                                    boolean indirect)
                                                                                                                                    throws CSSException

Throws:

CSSException

getProvisioningReportForUsersWithRoles

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForUsersWithRoles(java.util.Map context,
                                                                                                                                    CSSPrincipalIF principal,
                                                                                                                                    java.util.Set<java.lang.String> roleIdentities,
                                                                                                                                    java.util.Set<java.lang.String> applicationIds,
                                                                                                                                    boolean indirect)
                                                                                                                                    throws CSSException

Throws:

CSSException

getProvisioningReportForGroupsWithRoles

java.util.Map<java.lang.String,java.util.List<com.hyperion.css.common.ProvisionReportEntry>> getProvisioningReportForGroupsWithRoles(java.util.Map context,
                                                                                                                                     CSSPrincipalIF principal,
                                                                                                                                     java.util.Set<java.lang.String> roleIdentities,
                                                                                                                                     java.util.Set<java.lang.String> applicationIds,
                                                                                                                                     boolean indirect)
                                                                                                                                     throws CSSException

Throws:

CSSException

getAllRoles

java.util.Set<com.hyperion.css.spi.impl.nvdb.NativeRoleImpl> getAllRoles(java.util.Map context,
                                                                         CSSPrincipalIF principal)
                                                                         throws CSSException

Throws:

CSSException