|
uPortal 2.3.2 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.wsrp.CConsumer
A uPortal WSRP consumer channel. There is a related channel type called "WSRP Consumer" that is included with uPortal, so to use this channel, just select "WSRP Consumer" when publishing.
Constructor Summary | |
CConsumer()
|
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 |
setRuntimeData(ChannelRuntimeData rd,
java.lang.String uid)
Sets the channel runtime data. |
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 |
Constructor Detail |
public CConsumer()
Method Detail |
public 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
|
uPortal 2.3.2 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |