|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletSession
Defines a session object at the consumer-side to store remote portlet related information that are needed to interact with the portlet. Since a session context is not mandatory in WSRP a consumer portlet instance key is taken to uniquely identify a portlet session.
Method Summary | |
---|---|
java.util.Iterator |
getAllPorletWindowSessions()
Get all window session which belong to the portlet session |
java.lang.String |
getPortletHandle()
Get the portlet handle which uniquely identifies the portlet session at the consumer side. |
PortletWindowSession |
getPortletWindowSession(java.lang.String windowID)
Get the SimplePortletWindowSession of the portlet window with the given ID. |
SessionContext |
getSessionContext()
Get the WSRP session context of the portlet instance. |
void |
removeAllPortletWindowSessions()
Remove all portlet window sessions which belong to this portlet session. |
PortletWindowSession |
removePortletWindowSession(java.lang.String windowID)
Remove the porlet window session with the given window id. |
void |
setPortletHandle(java.lang.String portletHandle)
Set the portlet handle of the portlet this session belongs to. |
void |
setSessionContext(SessionContext sessionContext)
Set the session context of the portlet instance. |
Method Detail |
---|
java.lang.String getPortletHandle()
void setPortletHandle(java.lang.String portletHandle)
portletHandle
- The portlet handleSessionContext getSessionContext()
void setSessionContext(SessionContext sessionContext)
sessionContext
- The session context.PortletWindowSession getPortletWindowSession(java.lang.String windowID)
SimplePortletWindowSession
of the portlet window with the given ID.
windowID
- The ID of the portlet window
PorletWindowSession
with the given ID.java.util.Iterator getAllPorletWindowSessions()
SimplePortletWindowSession
objects.PortletWindowSession removePortletWindowSession(java.lang.String windowID)
windowID
- The ObjectID of the portlet window whichs session shoul dbe removed
void removeAllPortletWindowSessions()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |