|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.UserInstance
A class handling holding all user state information. The class is also reponsible for request processing and orchestrating the entire rendering procedure. (this is a replacement for the good old LayoutBean class)
Field Summary | |
static boolean |
CACHE_ENABLED
|
static boolean |
CHARACTER_CACHE_ENABLED
|
static int |
guestUserId
|
static java.lang.String |
USER_LAYOUT_ROOT_NODE
|
Constructor Summary | |
UserInstance(IPerson person)
|
Method Summary | |
IPerson |
getPerson()
Gets the person object from the session. |
void |
renderState(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res,
ChannelManager channelManager,
LocaleManager localeManager,
IUserPreferencesManager upm,
java.lang.Object rendering_lock)
renderState method orchestrates the rendering pipeline. |
void |
valueBound(javax.servlet.http.HttpSessionBindingEvent bindingEvent)
Notifies UserInstance that it has been bound to a session. |
void |
valueUnbound(javax.servlet.http.HttpSessionBindingEvent bindingEvent)
This notifies UserInstance that it has been unbound from the session. |
void |
writeContent(javax.servlet.http.HttpServletRequest req,
javax.servlet.http.HttpServletResponse res)
Prepares for and initates the rendering cycle. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int guestUserId
public static final boolean CACHE_ENABLED
public static final boolean CHARACTER_CACHE_ENABLED
public static final java.lang.String USER_LAYOUT_ROOT_NODE
Constructor Detail |
public UserInstance(IPerson person)
Method Detail |
public void writeContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) throws PortalException
req
- the servlet request objectres
- the servlet response object
PortalException
public void renderState(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, ChannelManager channelManager, LocaleManager localeManager, IUserPreferencesManager upm, java.lang.Object rendering_lock) throws PortalException
renderState
method orchestrates the rendering pipeline.
req
- the HttpServletRequest
res
- the HttpServletResponse
channelManager
- the ChannelManager
instanceupm
- the IUserPreferencesManager
instancerendering_lock
- a lock for rendering on a single user
PortalException
- if an error occurspublic IPerson getPerson()
public void valueUnbound(javax.servlet.http.HttpSessionBindingEvent bindingEvent)
valueUnbound
in interface javax.servlet.http.HttpSessionBindingListener
bindingEvent
- an HttpSessionBindingEvent
valuepublic void valueBound(javax.servlet.http.HttpSessionBindingEvent bindingEvent)
valueBound
in interface javax.servlet.http.HttpSessionBindingListener
bindingEvent
- a HttpSessionBindingEvent
value
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |