oracle.epm.fm.domainobject.security

Class Security

java.lang.Object

oracle.epm.fm.domainobject.security.Security

public class Security
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	bUserHasCreateAppRight
protected boolean	bUserHasManageTaskflowRight
protected boolean	bUserHasProjectManagerRight
protected boolean	bUserHasSysAdminRight
protected static com.hyperion.css.CSSAPIIF	cssApi
protected static com.hyperion.css.CSSSystem	cssInstance
protected static com.hyperion.css.CSSUserProvisioningAPIIF	cssProvisioning
protected com.hyperion.css.common.CSSUserIF	cssUser
protected String[]	groupIds
protected String[]	groupNames
protected List<String>	provisionedApps
protected String	ssoToken
protected String[]	userCssGlobalRoles
protected String[]	userEmailAddresses
protected String	userFullName
protected String	userId
protected String	userName
protected com.hyperion.css.common.CSSPrincipalIF	userPrincipal

Constructor Summary

Constructors

Constructor and Description
Security() This constructor should only be called from Session object constructor or initialization method.

Method Summary

Modifier and Type	Method and Description
void	authenticateUser(String userName, String password, String ssoToken) authenticateUser should only be call once per user ADF session.
boolean	doesUserHasCreateAppRight()
boolean	doesUserHasManageTaskflowRight()
boolean	doesUserHasProjectManagerRight()
boolean	doesUserHasSysAdminRight()
com.hyperion.css.common.CSSUserIF	getCssUser()
protected String	getFullUserName(com.hyperion.css.common.CSSUserIF user) Get user full name from CSS
String[]	getGroupIds()
String[]	getGroupNames()
String	getSsoToken()
String	getSSOTokenUsingWebSecurityAgentCredentials(String internalAccessCode, String webSecurityAgentUserId) Gets the sso token using Web Security Agent credentials
String[]	getUserCssGlobalRoles()
String[]	getUserEmailAddresses()
String	getUserFullName()
String	getUserId()
String	getUserName()
List<String>	getUserProvisionedApps() This funcntion return a list of application name that the authenticated user is provisioned to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cssInstance

protected static com.hyperion.css.CSSSystem cssInstance

cssApi

protected static com.hyperion.css.CSSAPIIF cssApi

cssProvisioning

protected static com.hyperion.css.CSSUserProvisioningAPIIF cssProvisioning

ssoToken

protected String ssoToken

cssUser

protected com.hyperion.css.common.CSSUserIF cssUser

userPrincipal

protected com.hyperion.css.common.CSSPrincipalIF userPrincipal

userId

protected String userId

userName

protected String userName

userFullName

protected String userFullName

userEmailAddresses

protected String[] userEmailAddresses

groupNames

protected String[] groupNames

groupIds

protected String[] groupIds

userCssGlobalRoles

protected String[] userCssGlobalRoles

provisionedApps

protected List<String> provisionedApps

bUserHasSysAdminRight

protected boolean bUserHasSysAdminRight

bUserHasCreateAppRight

protected boolean bUserHasCreateAppRight

bUserHasProjectManagerRight

protected boolean bUserHasProjectManagerRight

bUserHasManageTaskflowRight

protected boolean bUserHasManageTaskflowRight

Constructor Detail

Security

public Security()
         throws HFMException

This constructor should only be called from Session object constructor or initialization method. When Security object is created - it will initialized the user to have no roles / access right. - retrieve HFM Role cache. This cache will be useful to convert from CSS role to HFMRoleEnum

Throws:

HFMException

Method Detail

authenticateUser

public void authenticateUser(String userName,
                             String password,
                             String ssoToken)
                      throws HFMException

authenticateUser should only be call once per user ADF session. It will try to authenticate the input ssoToken first if it's not Empty or null. Otherwise, it will authenticate user based on the input userName and password. If the user is authenticated. This method will also retrieve his / her information such as groups, email addresses as well as wether user has the right to create applicaiton or access system admin module If this method is called again with the same ssoToken, it will not re-authenticate the user

Parameters:

userName - user name of the user to be authenticated. Will not be used if ssoToken is not null or empty

password - password of the associate user to be authenticated. Will not be used if ssoToken is not null or empty

ssoToken - - ssoToken associated with the user. This should be passed in to us by worskpace or external integration

Throws:

HFMException

getUserProvisionedApps

public List<String> getUserProvisionedApps()
                                    throws HFMException

This funcntion return a list of application name that the authenticated user is provisioned to. This list can be empty

Returns:

the list of application name that the user is provisioned to.

Throws:

HFMException

getFullUserName

protected String getFullUserName(com.hyperion.css.common.CSSUserIF user)

Get user full name from CSS

Parameters:

user - - CSSUserIF object

Returns:

getCssUser

public com.hyperion.css.common.CSSUserIF getCssUser()

getSsoToken

public String getSsoToken()

getUserId

public String getUserId()

getUserName

public String getUserName()

getUserFullName

public String getUserFullName()

getUserEmailAddresses

public String[] getUserEmailAddresses()

getGroupNames

public String[] getGroupNames()

getGroupIds

public String[] getGroupIds()

doesUserHasSysAdminRight

public boolean doesUserHasSysAdminRight()

doesUserHasCreateAppRight

public boolean doesUserHasCreateAppRight()

doesUserHasProjectManagerRight

public boolean doesUserHasProjectManagerRight()

getUserCssGlobalRoles

public String[] getUserCssGlobalRoles()

doesUserHasManageTaskflowRight

public boolean doesUserHasManageTaskflowRight()

getSSOTokenUsingWebSecurityAgentCredentials

public String getSSOTokenUsingWebSecurityAgentCredentials(String internalAccessCode,
                                                          String webSecurityAgentUserId)
                                                   throws HFMException

Gets the sso token using Web Security Agent credentials

Parameters:

internalAccessCode -

webSecurityAgentUserId -

Returns:

sso token

Throws:

HFMException