Skip navigation links


com.essbase.eas.framework.defs
Class FrameworkUser

java.lang.Object
  extended by com.essbase.eas.framework.defs.FrameworkUser


public class FrameworkUser
extends java.lang.Object

Represents a logged in FrameworkUser in the EAS Console

Since:
6.5.4
Version:
6.5.4
Author:
Scott Rasmussen

Constructor Summary
FrameworkUser()
           
FrameworkUser(java.lang.String userName, java.lang.String pwd, java.lang.String userToken, java.lang.String svr, int svrPort, java.lang.String emailAddr, java.lang.String emailName, java.lang.String mailHost, boolean supervisor)
          Convenience constructor for a user that has not logged in with a token

 

Method Summary
 java.lang.String getDecryptedToken()
           
 java.lang.String getEmail()
          The email address for this user
 java.lang.String getEmailHost()
          Returns the String representing the host used to send e-mail
 java.lang.String getEncryptedPassword()
          Gets the encrypted password for this user
 java.lang.String getFullName()
          This is the user's full name typically used when sending an e-mail
 java.lang.String getPassword()
          Returns the FrameworkUser's password in an unencrypted form.
 int getPort()
          Returns the port number used to connect to on the server
 java.lang.Object getProperty(java.lang.String key)
          Returns the object representing the value for the key in the properties set
 java.lang.String getServer()
          Returns the server to connect to
 java.lang.String getToken()
          Gets the String containing the token
 java.lang.String getUserName()
          Returns theFrameworkUser's login name
 boolean hasToken()
          Returns a boolean value specifying if the token is defined
static boolean isDefaultPropertyCheckingSupported()
          This property is used to check if a default value is supported by this class.
static boolean isDefaultValue(java.lang.String propertyName, java.lang.Object o)
          Checks if the value in the argument is the same as the default value defined for this class.
 boolean isSupervisor()
          Returns a boolean value representing if this user is a supervisor
 void setClearPassword(java.lang.String pwd)
          Use this method to reinitialize the FrameworkUser's password
 void setEmail(java.lang.String emailAddress)
          Assigns the emailAddress for this FrameworkUser
 void setEmailHost(java.lang.String host)
          Assigns the email server to use for sending email.
 void setEncryptedPassword(java.lang.String pwd)
          Encrypts the pwd string and stores it as the encrypted password for this user.
 void setFullName(java.lang.String fullName)
          Assigns the user's full name typically used when sending an e-mail
 void setPort(int svrPort)
          Assigns the port number on the server for this user to connect to
 void setProperty(java.lang.String key, java.lang.Object value)
          Sets this key/value pair in the properties set.
 void setServer(java.lang.String svr)
          Assigns the server for the FrameworkUser
 void setSupervisor(boolean supervisor)
          Grants supervisor privileges for this user based on the input boolean value
 void setToken(java.lang.String userToken)
          Sets this user's token
 void setUserName(java.lang.String userName)
          Assigns theFrameworkUser's login name

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

FrameworkUser

public FrameworkUser()

FrameworkUser

public FrameworkUser(java.lang.String userName,
                     java.lang.String pwd,
                     java.lang.String userToken,
                     java.lang.String svr,
                     int svrPort,
                     java.lang.String emailAddr,
                     java.lang.String emailName,
                     java.lang.String mailHost,
                     boolean supervisor)
Convenience constructor for a user that has not logged in with a token
Parameters:
userName - the login name for the user
pwd - the unencrypted password of the user
userToken - the Hyperion SDK Token
svr - the server to connect to
svrPort - the port number on the server
emailAddr - is the email address of the user
emailName - the full name to appear in email
mailHost - the host used to send email as used by Java Mail API
supervisor - determines if this user has supervisor privileges

Method Detail

getUserName

public java.lang.String getUserName()
Returns theFrameworkUser's login name
Returns:
the user's login name

setUserName

public void setUserName(java.lang.String userName)
Assigns theFrameworkUser's login name
Parameters:
userName - the login name to be set for this FrameworkUser

getPassword

public java.lang.String getPassword()
Returns the FrameworkUser's password in an unencrypted form.
Returns:
the unencrypted password for this user.

setClearPassword

public void setClearPassword(java.lang.String pwd)
Use this method to reinitialize the FrameworkUser's password
Parameters:
pwd - the password to be set for this user. This is stored in an encrypted form

getEncryptedPassword

public java.lang.String getEncryptedPassword()
Gets the encrypted password for this user
Returns:
the encrypted password for this user

setEncryptedPassword

public void setEncryptedPassword(java.lang.String pwd)
Encrypts the pwd string and stores it as the encrypted password for this user.
Parameters:
pwd - the password string to be encrypted

getServer

public java.lang.String getServer()
Returns the server to connect to
Returns:
the name of the server the FrameworkUser connects to

setServer

public void setServer(java.lang.String svr)
Assigns the server for the FrameworkUser
Parameters:
svr - is the server to use for this user

getPort

public int getPort()
Returns the port number used to connect to on the server
Returns:
the port number on the server to connect to

setPort

public void setPort(int svrPort)
Assigns the port number on the server for this user to connect to
Parameters:
svrPort - the port number to set

getEmail

public java.lang.String getEmail()
The email address for this user
Returns:
the email address for this FrameworkUser

setEmail

public void setEmail(java.lang.String emailAddress)
Assigns the emailAddress for this FrameworkUser
Parameters:
emailAddress - the email address to set for this user

getFullName

public java.lang.String getFullName()
This is the user's full name typically used when sending an e-mail
Returns:
the full name of this user

setFullName

public void setFullName(java.lang.String fullName)
Assigns the user's full name typically used when sending an e-mail
Parameters:
fullName - the full name to set for the user

getEmailHost

public java.lang.String getEmailHost()
Returns the String representing the host used to send e-mail
Returns:
the host used to send e-mail.

setEmailHost

public void setEmailHost(java.lang.String host)
Assigns the email server to use for sending email. Used by the Java Mail API
Parameters:
host - the host used to send e-mail.

hasToken

public boolean hasToken()
Returns a boolean value specifying if the token is defined
Returns:
returns true, if the user has a non-blank token, false if it is blank

getToken

public java.lang.String getToken()
Gets the String containing the token
Returns:
the Hyperion Security SDK generated token.

getDecryptedToken

public java.lang.String getDecryptedToken()

setToken

public void setToken(java.lang.String userToken)
Sets this user's token
Parameters:
userToken - sets the token for this Framework User

isSupervisor

public boolean isSupervisor()
Returns a boolean value representing if this user is a supervisor
Returns:
returns true if this user has supervisor privileges, false is not

setSupervisor

public void setSupervisor(boolean supervisor)
Grants supervisor privileges for this user based on the input boolean value
Parameters:
supervisor - sets the supervisor privileges

getProperty

public java.lang.Object getProperty(java.lang.String key)
Returns the object representing the value for the key in the properties set
Parameters:
key - the key for which the value has to be returned
Returns:
the value corresponding to the key in the properties set

setProperty

public void setProperty(java.lang.String key,
                        java.lang.Object value)
Sets this key/value pair in the properties set.
Parameters:
key - the key for the key/value pair
value - the value for the key/value pair

isDefaultValue

public static boolean isDefaultValue(java.lang.String propertyName,
                                     java.lang.Object o)
Checks if the value in the argument is the same as the default value defined for this class.
Parameters:
propertyName - is the name of the property to check for
o - is the value of the value of the property
Returns:
returns true if the default value for propertyName is o

isDefaultPropertyCheckingSupported

public static boolean isDefaultPropertyCheckingSupported()
This property is used to check if a default value is supported by this class.
Returns:
if this class supports the use of default values.

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.