Skip navigation links


com.essbase.api.datasource
Interface IEssOlapUser

All Superinterfaces:
IEssBaseObject, IEssExtendedObject, IEssProperties

public interface IEssOlapUser
extends IEssExtendedObject, IEssProperties

Nested Class Summary
static class IEssOlapUser.EEssAccess
          Enumeration for access types for a user.

 

Nested classes/interfaces inherited from interface com.essbase.api.base.IEssProperties
IEssProperties.EEssPropertyMode

 

Field Summary
static int PROP_ACCESS
           
static int PROP_APP_NAME
           
static int PROP_CONNECTION_PARAM
           
static int PROP_DB_CONNECTION_TIME
           
static int PROP_DB_NAME
           
static int PROP_DESCRIPTION
           
static int PROP_EMAIL_ID
           
static int PROP_EXPIRATION
           
static int PROP_FAIL_COUNT
           
static int PROP_LAST_LOGIN
           
static int PROP_LOCKED_OUT
           
static int PROP_LOGIN
           
static int PROP_LOGIN_ID
           
static int PROP_MAX_ACCESS
           
static int PROP_NAME
           
static int PROP_PASSWORD
           
static int PROP_PASSWORD_CHANGE_NOW
           
static int PROP_PROTOCOL
           
static int s_countProperties
           
static IEssValueAny.EEssDataType[] s_propDataTypes
           
static IEssProperties.EEssPropertyMode[] s_propModes
           
static java.lang.String[] s_propNames
           

 

Method Summary
 void addToGroup(IEssOlapGroup group)
          Adds user to the specified group.
 void changePassword(java.lang.String newPassword)
          Changes the password of this user in the Essbase server.
 void deleteUser()
          Deletes the user.
 long getAccess()
          Gets the default access privileges assigned to user.
 java.lang.String getApplicationName()
          Gets the name of currently connected application (if applicable).
 java.lang.String getAuthenticationConnectionParam()
          Get external authentication connection parameter string.
 java.lang.String getAuthenticationProtocol()
          Gets external authentication protocol if the user is an external user.
 long getCubeConnectionTime()
          Local (essbase server) time of cube connection.
 java.lang.String getCubeName()
          Gets the name of the currently connected cube (if applicable).
 java.lang.String getDescription()
          Get user description.
 java.lang.String getEmailID()
          Get user email ID.
 short getFailedLoginCount()
          Count of the failed login attempts since the last successful login.
 IEssIterator getGroups()
          Gets the list of groups this user is a member of.
 long getLastLoginDate()
          Gets the date of user's last successful login stated as Greenwich Mean Time.
 boolean getLogin()
          Flag to indicate whether the user is currently logged in.
 long getLoginId()
          The user login identification tag.
 long getMaxAccess()
          Get the user's maximum access privileges (including individual access and access levels due to group membership).
 java.lang.String getName()
          Gets the Internally/ Externally authenticed User name.
 java.lang.String getPassword()
          Gets the Password of externally authenticated user.
 long getPasswordExpirationDate()
          Gets user's password expiration date.
 short getUserType()
          Gets the application access type of user.
 boolean isLockedOut()
          Flag that user is locked out.
 boolean isPasswordChangeNeededNow()
          Flag that user must change password.
 void refreshPropertyValues()
          Refreshes the property values.
 void removeFromGroup(IEssOlapGroup group)
          Removes user from the specified group.
 void renameUser(java.lang.String newName)
          Renames the existing user.
 void setAccess(long access)
          Sets the default access privileges assigned to user.
 void setPasswordChangeNeededNow(boolean passwordChangeNow)
          Deprecated. Replaced with setUser(EEssAccess, long, boolean)
 void setPasswordExpirationDate(long expiration)
           
 void setUser(IEssOlapUser.EEssAccess access, long Expiration, boolean passwordChgNow)
          Sets a user information structure, which contains security information for the user.
 void setUserType(short userType, short Cmd)
          Enables you to define the application access type for a user.
 void syncUserWithApp(IEssOlapApplication application)
          Forces a user to be synchronized with security information for the application, so that the user's security information matches the status of Shared Services security.
 void updatePropertyValues()
          Updates the property values.

 

Methods inherited from interface com.essbase.api.base.IEssExtendedObject
clearClientCache, getParent, getParentBase, isClientCachingEnabled, setClientCachingEnabled

 

Methods inherited from interface com.essbase.api.base.IEssProperties
getCountProperties, getPropertyDataType, getPropertyDataType, getPropertyDataTypes, getPropertyId, getPropertyMode, getPropertyMode, getPropertyModes, getPropertyName, getPropertyNames, getPropertyValueAny, getPropertyValueAny, setPropertyValueAny, setPropertyValueAny

 

Field Detail

PROP_NAME

static final int PROP_NAME
See Also:
Constant Field Values

PROP_APP_NAME

static final int PROP_APP_NAME
See Also:
Constant Field Values

PROP_DB_NAME

static final int PROP_DB_NAME
See Also:
Constant Field Values

PROP_LOGIN

static final int PROP_LOGIN
See Also:
Constant Field Values

PROP_ACCESS

static final int PROP_ACCESS
See Also:
Constant Field Values

PROP_MAX_ACCESS

static final int PROP_MAX_ACCESS
See Also:
Constant Field Values

PROP_EXPIRATION

static final int PROP_EXPIRATION
See Also:
Constant Field Values

PROP_LAST_LOGIN

static final int PROP_LAST_LOGIN
See Also:
Constant Field Values

PROP_DB_CONNECTION_TIME

static final int PROP_DB_CONNECTION_TIME
See Also:
Constant Field Values

PROP_FAIL_COUNT

static final int PROP_FAIL_COUNT
See Also:
Constant Field Values

PROP_LOGIN_ID

static final int PROP_LOGIN_ID
See Also:
Constant Field Values

PROP_DESCRIPTION

static final int PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_EMAIL_ID

static final int PROP_EMAIL_ID
See Also:
Constant Field Values

PROP_LOCKED_OUT

static final int PROP_LOCKED_OUT
See Also:
Constant Field Values

PROP_PASSWORD_CHANGE_NOW

static final int PROP_PASSWORD_CHANGE_NOW
See Also:
Constant Field Values

PROP_PROTOCOL

static final int PROP_PROTOCOL
See Also:
Constant Field Values

PROP_CONNECTION_PARAM

static final int PROP_CONNECTION_PARAM
See Also:
Constant Field Values

PROP_PASSWORD

static final int PROP_PASSWORD
See Also:
Constant Field Values

s_countProperties

static final int s_countProperties
See Also:
Constant Field Values

s_propNames

static final java.lang.String[] s_propNames

s_propDataTypes

static final IEssValueAny.EEssDataType[] s_propDataTypes

s_propModes

static final IEssProperties.EEssPropertyMode[] s_propModes

Method Detail

getName

java.lang.String getName()
                         throws com.essbase.api.base.EssException
Gets the Internally/ Externally authenticed User name.
Specified by:
getName in interface IEssExtendedObject
Returns:
The user name.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getPassword

java.lang.String getPassword()
                             throws com.essbase.api.base.EssException
Gets the Password of externally authenticated user. This is used only when getting an externally authenticated user to the Essbase authenticated mechanisms. This password is ignored in other situations, including retrieving information from the server on the externally authenticated user.
Returns:
password The password.
Throws:
com.essbase.api.base.EssException - if an error occurs.

getApplicationName

java.lang.String getApplicationName()
                                    throws com.essbase.api.base.EssException
Gets the name of currently connected application (if applicable).
Returns:
ApplicationName
Throws:
com.essbase.api.base.EssException

getCubeName

java.lang.String getCubeName()
                             throws com.essbase.api.base.EssException
Gets the name of the currently connected cube (if applicable).
Returns:
CubeName
Throws:
com.essbase.api.base.EssException

getLogin

boolean getLogin()
                 throws com.essbase.api.base.EssException
Flag to indicate whether the user is currently logged in.
Returns:
boolean login
Throws:
com.essbase.api.base.EssException

getAccess

long getAccess()
               throws com.essbase.api.base.EssException
Gets the default access privileges assigned to user. User or group assigned default access privileges. Values: any combination of the following bit values:
Returns:
long Access
Throws:
com.essbase.api.base.EssException
See Also:
- Supervisor, all bits set, - Application create/delete privilege, - User create/delete privilege

setAccess

void setAccess(long access)
               throws com.essbase.api.base.EssException
Sets the default access privileges assigned to user.
Parameters:
access - the default access level
Throws:
com.essbase.api.base.EssException

getMaxAccess

long getMaxAccess()
                  throws com.essbase.api.base.EssException
Get the user's maximum access privileges (including individual access and access levels due to group membership). Values would be one of access privileges as in EssGlobalStrings
Returns:
long MaxAccess
Throws:
com.essbase.api.base.EssException
See Also:
EssGlobalStrings

getPasswordExpirationDate

long getPasswordExpirationDate()
                               throws com.essbase.api.base.EssException
Gets user's password expiration date.
Returns:
Date Expiration
Throws:
com.essbase.api.base.EssException

setPasswordExpirationDate

void setPasswordExpirationDate(long expiration)
                               throws com.essbase.api.base.EssException
Parameters:
expiration - - Date expiration
Throws:
com.essbase.api.base.EssException

getLastLoginDate

long getLastLoginDate()
                      throws com.essbase.api.base.EssException
Gets the date of user's last successful login stated as Greenwich Mean Time.
Returns:
Date LastLogin
Throws:
com.essbase.api.base.EssException

getCubeConnectionTime

long getCubeConnectionTime()
                           throws com.essbase.api.base.EssException
Local (essbase server) time of cube connection.
Returns:
Date DbConnectionTime
Throws:
com.essbase.api.base.EssException

getFailedLoginCount

short getFailedLoginCount()
                          throws com.essbase.api.base.EssException
Count of the failed login attempts since the last successful login.
Returns:
short FailCount
Throws:
com.essbase.api.base.EssException

getLoginId

long getLoginId()
                throws com.essbase.api.base.EssException
The user login identification tag.
Returns:
String LoginID
Throws:
com.essbase.api.base.EssException

getDescription

java.lang.String getDescription()
                                throws com.essbase.api.base.EssException
Get user description.
Returns:
String Description
Throws:
com.essbase.api.base.EssException

getEmailID

java.lang.String getEmailID()
                            throws com.essbase.api.base.EssException
Get user email ID.
Returns:
String EmailID
Throws:
com.essbase.api.base.EssException

isLockedOut

boolean isLockedOut()
                    throws com.essbase.api.base.EssException
Flag that user is locked out.
Returns:
boolean LockedOut
Throws:
com.essbase.api.base.EssException

isPasswordChangeNeededNow

boolean isPasswordChangeNeededNow()
                                  throws com.essbase.api.base.EssException
Flag that user must change password.
Returns:
boolean passwordChangeNow
Throws:
com.essbase.api.base.EssException

setPasswordChangeNeededNow

void setPasswordChangeNeededNow(boolean passwordChangeNow)
                                throws com.essbase.api.base.EssException
Deprecated. Replaced with setUser(EEssAccess, long, boolean)
Set the flag that user must change password on the next login.
Parameters:
passwordChangeNow -
Throws:
com.essbase.api.base.EssException

getAuthenticationProtocol

java.lang.String getAuthenticationProtocol()
                                           throws com.essbase.api.base.EssException
Gets external authentication protocol if the user is an external user.
Returns:
String protocol
Throws:
com.essbase.api.base.EssException

getAuthenticationConnectionParam

java.lang.String getAuthenticationConnectionParam()
                                                  throws com.essbase.api.base.EssException
Get external authentication connection parameter string.
Returns:
String ConnectionParam
Throws:
com.essbase.api.base.EssException

getGroups

IEssIterator getGroups()
                       throws com.essbase.api.base.EssException
Gets the list of groups this user is a member of. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server, unless they are a user getting their own list of groups.
Returns:
String ConnectionParam
Throws:
com.essbase.api.base.EssException

changePassword

void changePassword(java.lang.String newPassword)
                    throws com.essbase.api.base.EssException
Changes the password of this user in the Essbase server. User can change their own password or should have administrative priviledges to call this API.
Parameters:
newPassword - to be set.
Throws:
com.essbase.api.base.EssException

deleteUser

void deleteUser()
                throws com.essbase.api.base.EssException
Deletes the user. The caller may not delete itself nor the last Administrator on the server. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.
Throws:
com.essbase.api.base.EssException

renameUser

void renameUser(java.lang.String newName)
                throws com.essbase.api.base.EssException
Renames the existing user. The specified new user name must not already exist. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.
Parameters:
newName - - New name for renamed user. User names can be up to 30 characters long.
Throws:
com.essbase.api.base.EssException

refreshPropertyValues

void refreshPropertyValues()
                           throws com.essbase.api.base.EssException
Refreshes the property values. The JAPI cache for this object is refreshed with the latest values from the server, so that all the getXXX() methods will return the latest values.
Specified by:
refreshPropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

updatePropertyValues

void updatePropertyValues()
                          throws com.essbase.api.base.EssException
Updates the property values. The changes made to this object via setXXX() methods will become effective only after you invoke updatePropertyValues().
Specified by:
updatePropertyValues in interface IEssProperties
Throws:
com.essbase.api.base.EssException - if an error occurs.

syncUserWithApp

void syncUserWithApp(IEssOlapApplication application)
                     throws com.essbase.api.base.EssException
Forces a user to be synchronized with security information for the application, so that the user's security information matches the status of Shared Services security. If Essbase has not been migrated to Shared Services, this function is not supported and returns an error. This function requires the caller to be an Administrator.
Parameters:
application - - IEssOlapApplication, the application to sync with
Throws:
com.essbase.api.base.EssException

setUser

void setUser(IEssOlapUser.EEssAccess access,
             long Expiration,
             boolean passwordChgNow)
             throws com.essbase.api.base.EssException
Sets a user information structure, which contains security information for the user. The only fields in the user info structure which may be changed using this function are the Access, Expiration, and PwdChgNow fields (the other fields are for information only). The caller cannot give the specified user any access privileges that they themselves do not already have. The new user settings will take effect the next time the user logs in. This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server. This API is effective when Essbase is in native mode.
Parameters:
access - - User or group assigned default access privileges. Values: any combination of the following bit values: ESS_ACCESS_SUPER for Supervisor, all bits set ESS_PRIV_APPCREATE for App create/delete privilege ESS_PRIV_USERCREATE for user create/delete privilege
Expiration - - User's password expiration date.
passwordChgNow - - Flag that user must change password.
Throws:
com.essbase.api.base.EssException - - throws exception incase of any error
Since:
11.1.1.1

setUserType

void setUserType(short userType,
                 short Cmd)
                 throws com.essbase.api.base.EssException
Enables you to define the application access type for a user. You can add, remove, or replace different application access types for a user name. The application access type is a user property. If a user is created in Hyperion Planning, it automatically has an application access type of planning; if a user is created in Administration Services, it automatically has an application access type of essbase. Once a user is created, the application access type can be modified in the corresponding application using EssSetUserType.
Parameters:
userType - - Following is the available application access type: 1 which indicates ESS_USER_ESSBASE - the application access type, if no application access type is specified. This user will be enabled with all functionality.
Cmd - - Whether to add/remove/replace the type specified. possible values 0 which indicates ESS_USERTYPE_CMD_ADD - adds the new type specified to the existing application access type. 1 which indicates ESS_USERTYPE_CMD_REMOVE - removes the types specified from the existing application access type. Only the Analytic Services type, ESS_USER_ESSBASE, can be added or removed.
Throws:
com.essbase.api.base.EssException

getUserType

short getUserType()
                  throws com.essbase.api.base.EssException
Gets the application access type of user.
Returns:
userType - the application access type of the user. Two possible return values are 0 - means the user has no access over applications. 1- means the user has full access over the applications.
Throws:
com.essbase.api.base.EssException - if an error occurs.

addToGroup

void addToGroup(IEssOlapGroup group)
                throws com.essbase.api.base.EssException
Adds user to the specified group. It also adds user to the groups member list. This method requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.
Parameters:
group - Group to which user is to be added.
Throws:
com.essbase.api.base.EssException - if an error occurs.

removeFromGroup

void removeFromGroup(IEssOlapGroup group)
                     throws com.essbase.api.base.EssException
Removes user from the specified group. This method requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server. It also removes user from the groups member list.
Parameters:
group - Group from which user to be removed.
Throws:
com.essbase.api.base.EssException - if an error occurs.

Skip navigation links