|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.actuate.activeportal.beans.UserInfoBean
public class UserInfoBean
This bean contains the current logged in user information such as authentication id, volume name, server url, etc. and user interface settings. It is initialized when a user logged in to ActivePortal and set as a request attribute with the key "userinfobean".
It can be accessed from a JSP page like this:
<jsp:useBean id="userinfobean"
class="com.actuate.activeportal.beans.UserInfoBean"
scope="request"/>
<%
String userid = userinfobean.getUserid();
%>
You can store your own user property using setProperty
and
getProperty
methods which uses java.util.Properties to store
properties.
User interface information:
Constructor Summary | |
---|---|
UserInfoBean()
|
Method Summary | |
---|---|
com.actuate.common.util.AcLocale |
getAcLocale()
Gets the actuate locale for the current logged in user. |
java.lang.String |
getAdminRights()
Returns the administrator rights of the logged in user. |
java.lang.String |
getArchiveLibrary()
This method can be used only in Management Console application Returns the name of the archive library |
java.lang.String |
getArchiveServiceCmd()
|
java.lang.Object |
getAttribute(java.lang.String name)
Get a custom attribute object |
java.lang.String |
getAuthid()
Gets the authentication ID for IDAPI |
java.lang.String |
getCurrentfolder()
Gets the last folder name accessed by the user |
java.lang.String |
getDefaultAnalyticsExpLevel()
Returns the default analytics experience level for this user. |
static java.lang.String |
getDefaultServerURL()
Returns the defaultServerURL. |
java.lang.String |
getDefaultUserName()
For internal use only. |
static java.lang.String |
getDefaultVolume()
Gets the volume name defined in web.xml file. |
java.lang.Boolean |
getEnableCustomEvent()
|
java.lang.Long |
getEventLagTime()
|
java.lang.Long |
getEventPollingDuration()
|
java.lang.Long |
getEventPollingInterval()
|
java.lang.String[] |
getExternalUserPropertyNames()
This method is used only in management console ( As the external user property are available only in Management console) Returns the names of all the external user properties for the volume. |
FeatureOptionsBean |
getFeatureOptionsBean()
Gets the FeatureOptionsBean |
com.actuate.activeportal.functionality.config.Feature[] |
getFeatures()
Returns list of available Features defined in functionality-level.config file. |
java.lang.String |
getFilter()
Returns the filter used in the file folder list content page. |
java.lang.String |
getHomefolder()
Gets the user's home folder |
java.lang.String |
getIportalid()
Gets the iPortal session ID |
com.actuate.iv.context.session.IVUserSession |
getIvUserSession()
Get IV user session. |
java.util.Locale |
getLocale()
Gets the current login user's java.util.Locale |
int |
getMaxJobPriority()
Gets the maximum Job Priority defined for the current user. |
java.lang.String |
getMultivolumeParameter()
|
java.lang.String |
getOnlylatest()
Returns value indicating whether only latest version of files/folders are to be displayed in the file folder list page. |
java.lang.String |
getPassword()
Gets the password |
ProfileBean |
getProfile()
Gets the ProfileBean. |
java.lang.String |
getProperty(java.lang.String name)
Get a custom property value |
java.lang.String |
getRepositoryType()
Gets the repository type |
java.lang.String[] |
getRoleNames()
Returns the list of feature rolenames to which the current user belongs. |
java.lang.String |
getServerurl()
Gets the server URL to which the current user is logged in to. |
java.lang.String |
getShowdocuments()
Returns whether documents are to be displayed the file folder list page. |
java.lang.String |
getShowexecutables()
Returns whether executables are to be displayed in the file folde list page |
java.lang.String |
getShowfolders()
Returns whether folders are to be displayed in the file folder list page |
com.actuate.activeportal.functionality.config.Feature[] |
getSideBarFeatures()
Gets the list of Features available on the side bar. |
java.lang.String |
getSideBarSelected()
Returns the URL mapping of the selected item in the side bar. |
com.actuate.activeportal.skin.SkinConfig |
getSkinConfig()
Returns the Skin configuration that is used for the current user. |
java.lang.String |
getSkinName()
Returns the name of the skin used for the user. |
java.util.Collection |
getSubfeatures()
Returns list of subFeatures defined. |
java.lang.String |
getSystemname()
gets the iServer system name. |
com.actuate.reportcast.utils.AcTimeZone |
getTimezone()
Returns the user logged in timezone. |
java.util.Properties |
getUsageTerms()
Return the usage terms properties for this login user. |
UserAgentBean |
getUserAgent()
Returns the UserAgentBean |
java.lang.String |
getUserid()
Gets the logged in user name |
java.lang.String |
getView()
Returns the current view for this user |
java.lang.String |
getVolume()
Gets the user logged in volume name |
com.actuate.schemas.Volume |
getVolumeProperty()
Returns the properites of the current logged in volume This method can be used only in Management Console application |
void |
init(com.actuate.reportcast.utils.AcRequestHandlerBean requestHandlerBean)
Initializes the UserInfoBean members. |
boolean |
isAlwaysGetFolderList()
Returns if the Always get the folder list even if it is filtered. |
boolean |
isArchiveLibraryPresent()
Checks whether the archive library is present or not. |
boolean |
isDefaultRepositoryType()
|
boolean |
isDefaultServerUrl()
|
boolean |
isDefaultVolume()
|
boolean |
isEanalysisOptionEnabled()
Returns true if the eAnalysis option is enabled. |
boolean |
isEnterpriseRepository()
|
boolean |
isHomeFolderSet()
Returns if the home folder is set for the current logged in user. |
boolean |
isMC()
Determines whether the request originated from Management Console or not |
boolean |
isProfileInit()
returns true if the user profile has already been retrieved from the encyclopedia volume |
boolean |
isShowFilters()
Indicates whether the filter panel will be displayed. |
boolean |
isViewInNewBrowserWindow()
A boolean indicating whether the viewer is launched in the same window or a new window |
void |
setAcLocale(com.actuate.common.util.AcLocale acLocale)
Sets the actuate locale with the specified AcLocale object. |
void |
setAlwaysGetFolderList(boolean b)
Set value to true, to indicate to always get the folder list even if it is filtered. |
void |
setArchiveLibrary(java.lang.String string)
Sets the archive library name This method can be is used only in Management Console application. |
void |
setArchiveServiceCmd(java.lang.String string)
|
void |
setAttribute(java.lang.String name,
java.lang.Object attribute)
Set a custom attribute object |
void |
setAuthid(java.lang.String authid)
Sets the authentication ID for IDAPI |
void |
setCurrentfolder(java.lang.String currentfolder)
Sets the current folder accessed by the user. |
void |
setDefaultAnalyticsExpLevel(java.lang.String analyticsExpLevel)
This method is used to set the user's default analytics experience level |
static void |
setDefaultServerURL(java.lang.String defaultServerURL)
Sets the defaultServerURL. |
void |
setDefaultUserName(java.lang.String defaultUserName)
For internal use only. |
static void |
setDefaultVolume(java.lang.String defaultVolume)
Sets the volume to be used, if no volume name is specified in the url. |
void |
setEnableCustomEvent(java.lang.Boolean bValue)
|
void |
setEventLagTime(java.lang.Long nValue)
|
void |
setEventPollingDuration(java.lang.Long nValue)
|
void |
setEventPollingInterval(java.lang.Long nValue)
|
void |
setExternalUserPropertyNames(java.lang.String[] externalUserPropertyNames)
This method is used in management console. |
void |
setFeatureOptions(FeatureOptionsBean featureOptionsBean)
Sets the FeatureOptionBean |
void |
setFilter(java.lang.String filter)
Sets the filter to be used in the file folder list content page. |
void |
setHomefolder(java.lang.String string)
Sets the user's home folder |
void |
setIportalid(java.lang.String isessionid)
Sets the iPortal session ID |
void |
setIsMC(java.lang.String isMC)
Tells iPortal that this request is originating from Management Console or not |
void |
setIsProfileInit(java.lang.String isProfileSet)
Set's the userinfobean attribute isprofileinit. |
void |
setIvUserSession(com.actuate.iv.context.session.IVUserSession ivUserSession)
Set IV user session. |
void |
setMaxJobPriority(int priority)
Sets the maximum job priority for the current user. |
void |
setOnlylatest(java.lang.String onlylatest)
Sets value to indicate if only latest version of the document are to displayed in the file folder list |
void |
setPassword(java.lang.String password)
Sets the password |
void |
setProfile(ProfileBean bean)
Sets the ProfileBean. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Set a custom property value |
void |
setRepositoryType(java.lang.String type)
Sets the repository type |
void |
setRoleNames(java.lang.String[] strings)
Based on the list of rolenames to which the user belong it generates the FeatureOptionBean |
void |
setServerurl(java.lang.String surl)
Sets the iServer URL, example http://localhost:8000 |
void |
setShowdocuments(java.lang.String showdocuments)
Sets value to indicate if the documents are to displayed in the file folder list |
void |
setShowexecutables(java.lang.String showexecutables)
Sets value to indicate if the executables are to displayed in the file folder list |
void |
setShowFilters(boolean showFilters)
This method is used to indicate whether the filter panel should be shown for all the list pages. |
void |
setShowfolders(java.lang.String showfolders)
Sets value to indicate if folders to be displayed in the file folder list page |
void |
setSideBarFeatures(com.actuate.activeportal.functionality.config.Feature[] features)
Sets the list of features available on the sidebar. |
void |
setSideBarSelected(java.lang.String sideBarSelected)
Sets the url mapping of the selected item in the side bar. |
void |
setSkinConfig(com.actuate.activeportal.skin.SkinConfig config)
Method to set the skin configuration that is to be used for the current user. |
void |
setSkinName(java.lang.String name)
|
void |
setSkinName(java.lang.String string,
boolean isPreview)
Set the skin name to be used for the current user. |
void |
setSystemname(java.lang.String systemName)
Sets the iServer system name |
void |
setTimezone(com.actuate.reportcast.utils.AcTimeZone timezone)
Sets the timezone. |
void |
setUserAgent(UserAgentBean userAgent)
Sets the UserAgentBean |
void |
setUserid(java.lang.String userid)
Sets the logged in user name |
void |
setView(java.lang.String string)
See AcConstants.VIEWS for the list |
void |
setViewInNewBrowserWindow(boolean _newWindow)
This method is used to indicate whether the report viewer should be launched in a new window or in the same window |
void |
setVolume(java.lang.String volume)
Sets the volume name |
void |
setVolumeProperty(com.actuate.schemas.Volume volumeProperty)
Sets the volume information. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public UserInfoBean()
Method Detail |
---|
public java.util.Properties getUsageTerms()
public java.lang.String toString()
toString
in class java.lang.Object
public void setAttribute(java.lang.String name, java.lang.Object attribute)
name
- attribute name to be setattribute
- attribute to be set.public java.lang.Object getAttribute(java.lang.String name)
name
- attribute name to getpublic void setProperty(java.lang.String name, java.lang.String value)
name
- property name to be setvalue
- value to be set.public java.lang.String getProperty(java.lang.String name)
name
- property name to getpublic void setIsProfileInit(java.lang.String isProfileSet)
isProfileSet
- public boolean isProfileInit()
public void setAuthid(java.lang.String authid)
public java.lang.String getAuthid()
public java.lang.String getIportalid()
public void setIportalid(java.lang.String isessionid)
public java.lang.String getRepositoryType()
public void setRepositoryType(java.lang.String type)
public boolean isEnterpriseRepository()
public boolean isDefaultRepositoryType()
public boolean isMC()
public void setIsMC(java.lang.String isMC)
isMC
- public java.lang.String getPassword()
public void setPassword(java.lang.String password)
public java.lang.String getUserid()
public void setUserid(java.lang.String userid)
public void setServerurl(java.lang.String surl)
public java.lang.String getServerurl()
public boolean isDefaultServerUrl()
public void setSystemname(java.lang.String systemName)
public java.lang.String getSystemname()
public java.lang.String getCurrentfolder()
public void setCurrentfolder(java.lang.String currentfolder)
public java.lang.String getHomefolder()
public void setHomefolder(java.lang.String string)
public java.util.Locale getLocale()
public java.lang.String getVolume()
public void setVolume(java.lang.String volume)
public java.lang.String getFilter()
public boolean isDefaultVolume()
public void setFilter(java.lang.String filter)
filter
- The filter to setpublic java.lang.String getSideBarSelected()
public void setSideBarSelected(java.lang.String sideBarSelected)
sideBarSelected
- The sideBarSelected to setpublic com.actuate.common.util.AcLocale getAcLocale()
public void setAcLocale(com.actuate.common.util.AcLocale acLocale)
acLocale
- The acLocale to setpublic com.actuate.reportcast.utils.AcTimeZone getTimezone()
public void setTimezone(com.actuate.reportcast.utils.AcTimeZone timezone)
timezone
- The timezone to setpublic static java.lang.String getDefaultServerURL()
public static java.lang.String getDefaultVolume()
public static void setDefaultServerURL(java.lang.String defaultServerURL)
defaultServerURL
- The defaultServerURL to setpublic static void setDefaultVolume(java.lang.String defaultVolume)
defaultVolume
- The default volume name to be setpublic FeatureOptionsBean getFeatureOptionsBean()
public void setFeatureOptions(FeatureOptionsBean featureOptionsBean)
public boolean isEanalysisOptionEnabled()
public java.lang.String getDefaultUserName()
public void setDefaultUserName(java.lang.String defaultUserName)
public UserAgentBean getUserAgent()
public void setUserAgent(UserAgentBean userAgent)
userAgent
- The userAgent to setpublic boolean isHomeFolderSet()
public void init(com.actuate.reportcast.utils.AcRequestHandlerBean requestHandlerBean)
public com.actuate.activeportal.skin.SkinConfig getSkinConfig()
public java.lang.String getSkinName()
public void setSkinName(java.lang.String name)
public void setSkinName(java.lang.String string, boolean isPreview)
string
- public com.actuate.activeportal.functionality.config.Feature[] getFeatures()
public java.util.Collection getSubfeatures()
public java.lang.String[] getRoleNames()
public java.lang.String getAdminRights()
public void setRoleNames(java.lang.String[] strings)
strings
- list of role namespublic java.lang.String getView()
public void setView(java.lang.String string)
string
- AcConstants.VIEW_CATEGORY
AcConstants.VIEW_LIST
AcConstants.VIEW_DETAIL
AcConstants.VIEW_ICONpublic com.actuate.activeportal.functionality.config.Feature[] getSideBarFeatures()
public boolean isAlwaysGetFolderList()
public void setAlwaysGetFolderList(boolean b)
public void setShowFilters(boolean showFilters)
showFilters
- public boolean isShowFilters()
public void setViewInNewBrowserWindow(boolean _newWindow)
_newWindow
- (If this is true then the viewer is launched in a new window)public boolean isViewInNewBrowserWindow()
public void setSideBarFeatures(com.actuate.activeportal.functionality.config.Feature[] features)
public void setDefaultAnalyticsExpLevel(java.lang.String analyticsExpLevel)
analyticsExpLevel
- public java.lang.String getDefaultAnalyticsExpLevel()
public ProfileBean getProfile()
public void setProfile(ProfileBean bean)
public void setSkinConfig(com.actuate.activeportal.skin.SkinConfig config)
public int getMaxJobPriority()
public void setMaxJobPriority(int priority)
priority
- The maximum job prioritypublic com.actuate.schemas.Volume getVolumeProperty()
public void setVolumeProperty(com.actuate.schemas.Volume volumeProperty)
volumeProperty
- The volume properties for this userpublic java.lang.String[] getExternalUserPropertyNames()
public void setExternalUserPropertyNames(java.lang.String[] externalUserPropertyNames)
externalUserPropertyNames
- The externalUserPropertyNames to setpublic java.lang.String getOnlylatest()
public java.lang.String getShowdocuments()
public java.lang.String getShowexecutables()
public java.lang.String getShowfolders()
public void setOnlylatest(java.lang.String onlylatest)
onlylatest
- value "true" or "false"public void setShowdocuments(java.lang.String showdocuments)
showdocuments
- value "true" or "false"public void setShowexecutables(java.lang.String showexecutables)
showexecutables
- value "true" or "false"public void setShowfolders(java.lang.String showfolders)
showfolders
- value "true" or "false"public java.lang.String getMultivolumeParameter()
public java.lang.String getArchiveLibrary()
public void setArchiveLibrary(java.lang.String string)
string
- The archive library namepublic boolean isArchiveLibraryPresent()
public java.lang.String getArchiveServiceCmd()
public void setArchiveServiceCmd(java.lang.String string)
string
- public java.lang.Long getEventPollingInterval()
public void setEventPollingInterval(java.lang.Long nValue)
nValue
- public java.lang.Long getEventPollingDuration()
public void setEventPollingDuration(java.lang.Long nValue)
nValue
- public java.lang.Long getEventLagTime()
public void setEventLagTime(java.lang.Long nValue)
nValue
- public java.lang.Boolean getEnableCustomEvent()
public void setEnableCustomEvent(java.lang.Boolean bValue)
bValue
- public com.actuate.iv.context.session.IVUserSession getIvUserSession()
public void setIvUserSession(com.actuate.iv.context.session.IVUserSession ivUserSession)
ivUserSession
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |