|
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.channels.portlet.CPortletAdapter
A JSR 168 Portlet adapter that presents a portlet through the uPortal channel interface.
There is a related channel type called "Portlet Adapter" that is included with uPortal, so to use this channel, just select the "Portlet" type when publishing.
Note: A portlet can specify the String "password" in the
user attributes section of the portlet.xml. In this is done,
this adapter will look for the user's cached password. If
the user's password is being stored in memory by a caching
security context, the adapter will consult the cache to fill the
request for the attribute. If the user's password is not cached,
null
will be set for the attributes value.
Field Summary | |
static java.lang.String |
portletPreferenceNamePrefix
|
Constructor Summary | |
CPortletAdapter()
|
Method Summary | |
ChannelCacheKey |
generateKey(java.lang.String uid)
Generates a channel cache key. |
ChannelRuntimeProperties |
getRuntimeProperties(java.lang.String uid)
Sets channel runtime properties. |
boolean |
isCacheValid(java.lang.Object validity,
java.lang.String uid)
Determines whether the cached content for this channel is still valid. |
void |
receiveEvent(PortalEvent ev,
java.lang.String uid)
React to portal events. |
void |
renderCharacters(java.io.PrintWriter pw,
java.lang.String uid)
Output channel content to the portal as raw characters |
void |
renderXML(org.xml.sax.ContentHandler out,
java.lang.String uid)
Output channel content to the portal. |
void |
setPortalControlStructures(PortalControlStructures pcs,
java.lang.String uid)
Sets the portal control structures. |
void |
setResponse(java.lang.String uid,
javax.servlet.http.HttpServletResponse response)
Sets the HttpServletResponse for the channel to use. |
void |
setRuntimeData(ChannelRuntimeData rd,
java.lang.String uid)
Sets the channel runtime data. |
static void |
setServletConfig(javax.servlet.ServletConfig config)
Receive the servlet config from uPortal's PortalSessionManager servlet. |
void |
setStaticData(ChannelStaticData sd,
java.lang.String uid)
Sets the channel static data. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String portletPreferenceNamePrefix
Constructor Detail |
public CPortletAdapter()
Method Detail |
public static void setServletConfig(javax.servlet.ServletConfig config)
config
- the servlet configpublic ChannelRuntimeProperties getRuntimeProperties(java.lang.String uid)
getRuntimeProperties
in interface IMultithreadedChannel
uid
- a unique ID used to identify the state of the channel
public void receiveEvent(PortalEvent ev, java.lang.String uid)
receiveEvent
in interface IMultithreadedChannel
ev
- a portal eventuid
- a unique ID used to identify the state of the channelpublic void setStaticData(ChannelStaticData sd, java.lang.String uid) throws PortalException
setStaticData
in interface IMultithreadedChannel
sd
- the channel static datauid
- a unique ID used to identify the state of the channel
PortalException
public void setRuntimeData(ChannelRuntimeData rd, java.lang.String uid) throws PortalException
setRuntimeData
in interface IMultithreadedChannel
rd
- the channel runtime datauid
- a unique ID used to identify the state of the channel
PortalException
public void setPortalControlStructures(PortalControlStructures pcs, java.lang.String uid) throws PortalException
setPortalControlStructures
in interface IMultithreadedPrivileged
pcs
- the portal control structuresuid
- a unique ID used to identify the state of the channel
PortalException
PortalControlStructures
public void renderCharacters(java.io.PrintWriter pw, java.lang.String uid) throws PortalException
renderCharacters
in interface IMultithreadedCharacterChannel
pw
- a print writeruid
- a unique ID used to identify the state of the channel
PortalException
- if an error occurspublic void renderXML(org.xml.sax.ContentHandler out, java.lang.String uid) throws PortalException
renderXML
in interface IMultithreadedChannel
out
- a sax document handleruid
- a unique ID used to identify the state of the channel
PortalException
public ChannelCacheKey generateKey(java.lang.String uid)
generateKey
in interface IMultithreadedCacheable
uid
- the unique identifier
public boolean isCacheValid(java.lang.Object validity, java.lang.String uid)
Return true
when:
false
.
In other words, cache the content in all cases except for when a user clicks a channel button, a link or form button within the channel, or the focus or unfocus button.
isCacheValid
in interface IMultithreadedCacheable
validity
- the validity objectuid
- the unique identifier
true
if the cache is still valid, otherwise false
public void setResponse(java.lang.String uid, javax.servlet.http.HttpServletResponse response)
IMultithreadedDirectResponse
setResponse
in interface IMultithreadedDirectResponse
uid
- The unique ID of the channelresponse
- The HttpServletResponse for the channel to use.
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |