|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEssOlapUser
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 |
---|
static final int PROP_NAME
static final int PROP_APP_NAME
static final int PROP_DB_NAME
static final int PROP_LOGIN
static final int PROP_ACCESS
static final int PROP_MAX_ACCESS
static final int PROP_EXPIRATION
static final int PROP_LAST_LOGIN
static final int PROP_DB_CONNECTION_TIME
static final int PROP_FAIL_COUNT
static final int PROP_LOGIN_ID
static final int PROP_DESCRIPTION
static final int PROP_EMAIL_ID
static final int PROP_LOCKED_OUT
static final int PROP_PASSWORD_CHANGE_NOW
static final int PROP_PROTOCOL
static final int PROP_CONNECTION_PARAM
static final int PROP_PASSWORD
static final int s_countProperties
static final java.lang.String[] s_propNames
static final IEssValueAny.EEssDataType[] s_propDataTypes
static final IEssProperties.EEssPropertyMode[] s_propModes
Method Detail |
---|
java.lang.String getName() throws com.essbase.api.base.EssException
getName
in interface IEssExtendedObject
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getPassword() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.java.lang.String getApplicationName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String getCubeName() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
boolean getLogin() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
long getAccess() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- Supervisor, all bits set
, - Application create/delete privilege
, - User create/delete privilege
void setAccess(long access) throws com.essbase.api.base.EssException
access
- the default access levelcom.essbase.api.base.EssException
long getMaxAccess() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
EssGlobalStrings
long getPasswordExpirationDate() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void setPasswordExpirationDate(long expiration) throws com.essbase.api.base.EssException
expiration
- - Date expirationcom.essbase.api.base.EssException
long getLastLoginDate() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
long getCubeConnectionTime() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
short getFailedLoginCount() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
long getLoginId() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String getDescription() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String getEmailID() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
boolean isLockedOut() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
boolean isPasswordChangeNeededNow() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void setPasswordChangeNeededNow(boolean passwordChangeNow) throws com.essbase.api.base.EssException
setUser(EEssAccess, long, boolean)
passwordChangeNow
-com.essbase.api.base.EssException
java.lang.String getAuthenticationProtocol() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
java.lang.String getAuthenticationConnectionParam() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
IEssIterator getGroups() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void changePassword(java.lang.String newPassword) throws com.essbase.api.base.EssException
newPassword
- to be set.com.essbase.api.base.EssException
void deleteUser() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
void renameUser(java.lang.String newName) throws com.essbase.api.base.EssException
newName
- - New name for renamed user. User names can be up to 30 characters long.com.essbase.api.base.EssException
void refreshPropertyValues() throws com.essbase.api.base.EssException
refreshPropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void updatePropertyValues() throws com.essbase.api.base.EssException
updatePropertyValues
in interface IEssProperties
com.essbase.api.base.EssException
- if an error occurs.void syncUserWithApp(IEssOlapApplication application) throws com.essbase.api.base.EssException
application
- - IEssOlapApplication, the application to sync withcom.essbase.api.base.EssException
void setUser(IEssOlapUser.EEssAccess access, long Expiration, boolean passwordChgNow) throws com.essbase.api.base.EssException
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 privilegeExpiration
- - User's password expiration date.passwordChgNow
- - Flag that user must change password.com.essbase.api.base.EssException
- - throws exception incase of any errorvoid setUserType(short userType, short Cmd) throws com.essbase.api.base.EssException
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.com.essbase.api.base.EssException
short getUserType() throws com.essbase.api.base.EssException
com.essbase.api.base.EssException
- if an error occurs.void addToGroup(IEssOlapGroup group) throws com.essbase.api.base.EssException
group
- Group to which user is to be added.com.essbase.api.base.EssException
- if an error occurs.void removeFromGroup(IEssOlapGroup group) throws com.essbase.api.base.EssException
group
- Group from which user to be removed.com.essbase.api.base.EssException
- if an error occurs.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |