|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.UserPreferencesManager
public class UserPreferencesManager
UserPreferencesManager is responsible for keeping: user id, user layout, user preferences
and stylesheet descriptions.
For method descriptions please see IUserPreferencesManager
.
Field Summary | |
---|---|
private UserPreferences |
complete_up
|
private static boolean |
DEFAULT_SAVE_USER_PREFERENCES_AT_LOGOUT
Default value for saveUserPreferencesAtLogout. |
private static org.apache.commons.logging.Log |
log
|
(package private) IPerson |
m_person
|
private static boolean |
saveUserPreferencesAtLogout
|
private StructureStylesheetDescription |
ssd
|
private ThemeStylesheetDescription |
tsd
|
(package private) static PropsMatcher |
uaMatcher
|
private IUserLayoutManager |
ulm
|
(package private) IUserLayoutStore |
ulsdb
|
private boolean |
unmapped_user_agent
|
private static java.lang.String |
USER_PREFERENCES_KEY
|
Constructor Summary | |
---|---|
UserPreferencesManager(javax.servlet.http.HttpServletRequest req,
IPerson person)
Constructor does the following 1. |
|
UserPreferencesManager(javax.servlet.http.HttpServletRequest req,
IPerson person,
LocaleManager localeManager)
Constructor does the following 1. |
|
UserPreferencesManager(IPerson person)
A simpler constructor, that only initialises the person object. |
Method Summary | |
---|---|
void |
finishedSession(javax.servlet.http.HttpSessionBindingEvent bindingEvent)
|
protected java.lang.String |
getChannelPublishId(java.lang.String channelSubscribeId)
Returns a global channel Id given a channel instance Id |
UserProfile |
getCurrentProfile()
Returns current profile. |
IPerson |
getPerson()
Returns current person object |
StructureStylesheetDescription |
getStructureStylesheetDescription()
Returns current structure stylesheet description |
ThemeStylesheetDescription |
getThemeStylesheetDescription()
Returns current theme stylesheet description |
IUserLayoutManager |
getUserLayoutManager()
Returns IUserLayoutManager object for performing layout-related operations. |
UserPreferences |
getUserPreferences()
Returns current user preferences. |
UserPreferences |
getUserPreferencesCopy()
Returns a copy of the user preferences |
boolean |
isUserAgentUnmapped()
Determine if the user agent associated with this session has been successfuly mapped to a profile |
void |
processUserPreferencesParameters(javax.servlet.http.HttpServletRequest req)
|
void |
setNewUserLayoutAndUserPreferences(IUserLayoutManager newUlm,
UserPreferences newPreferences)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private static final org.apache.commons.logging.Log log
private static final java.lang.String USER_PREFERENCES_KEY
private static final boolean DEFAULT_SAVE_USER_PREFERENCES_AT_LOGOUT
static PropsMatcher uaMatcher
private IUserLayoutManager ulm
private UserPreferences complete_up
private ThemeStylesheetDescription tsd
private StructureStylesheetDescription ssd
private boolean unmapped_user_agent
IPerson m_person
IUserLayoutStore ulsdb
private static final boolean saveUserPreferencesAtLogout
Constructor Detail |
---|
public UserPreferencesManager(javax.servlet.http.HttpServletRequest req, IPerson person) throws PortalException
req
- the servlet request objectperson
- the person object
PortalException
public UserPreferencesManager(javax.servlet.http.HttpServletRequest req, IPerson person, LocaleManager localeManager) throws PortalException
req
- the servlet request objectperson
- the person objectlocaleManager
- the locale manager
PortalException
public UserPreferencesManager(IPerson person)
person
- an IPerson
object.Method Detail |
---|
public void processUserPreferencesParameters(javax.servlet.http.HttpServletRequest req)
processUserPreferencesParameters
in interface IUserPreferencesManager
public IPerson getPerson()
getPerson
in interface IUserPreferencesManager
IPerson
protected java.lang.String getChannelPublishId(java.lang.String channelSubscribeId) throws PortalException
channelSubscribeId
- subscribe id of a channel
PortalException
public boolean isUserAgentUnmapped()
IUserPreferencesManager
isUserAgentUnmapped
in interface IUserPreferencesManager
true
if no mapping was foundpublic void setNewUserLayoutAndUserPreferences(IUserLayoutManager newUlm, UserPreferences newPreferences) throws PortalException
setNewUserLayoutAndUserPreferences
in interface IUserPreferencesManager
PortalException
public IUserLayoutManager getUserLayoutManager()
IUserPreferencesManager
IUserLayoutManager
object for performing layout-related operations.
getUserLayoutManager
in interface IUserPreferencesManager
IUserLayoutManager
valuepublic void finishedSession(javax.servlet.http.HttpSessionBindingEvent bindingEvent)
finishedSession
in interface IUserPreferencesManager
public UserPreferences getUserPreferencesCopy()
IUserPreferencesManager
getUserPreferencesCopy
in interface IUserPreferencesManager
UserPreferences
objectpublic UserProfile getCurrentProfile()
IUserPreferencesManager
getCurrentProfile
in interface IUserPreferencesManager
UserProfile
public ThemeStylesheetDescription getThemeStylesheetDescription() throws java.lang.Exception
IUserPreferencesManager
getThemeStylesheetDescription
in interface IUserPreferencesManager
ThemeStylesheetDescription
java.lang.Exception
public StructureStylesheetDescription getStructureStylesheetDescription() throws java.lang.Exception
IUserPreferencesManager
getStructureStylesheetDescription
in interface IUserPreferencesManager
StructureStylesheetDescription
java.lang.Exception
public UserPreferences getUserPreferences()
IUserPreferencesManager
getUserPreferences
in interface IUserPreferencesManager
UserPreferences
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |