|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.BaseMultithreadedChannel
public abstract class BaseMultithreadedChannel
A base class from which channels implementing IMultithreadedChannel interface can be derived. Use this only if you are familiar with the IMultithreadedChannel interface. Channels that extend BaseMultithreadedChannel typically only need to override the renderXML method and should not contain any non-static member variables.
Nested Class Summary | |
---|---|
protected class |
BaseMultithreadedChannel.ChannelState
The channel's state including the static data, runtime data, portal event, and a channelData map which is analagous to the session for a servlet - the channel can stash objects in it. |
Field Summary | |
---|---|
protected static java.util.Map |
channelStateMap
|
protected org.apache.commons.logging.Log |
log
A Commons Logging log instance which will log as the runtime class extending this BaseChannel. |
Constructor Summary | |
---|---|
BaseMultithreadedChannel()
|
Method Summary | |
---|---|
ChannelRuntimeProperties |
getRuntimeProperties(java.lang.String uid)
Sets channel runtime properties. |
void |
receiveEvent(PortalEvent ev,
java.lang.String uid)
React to portal events. |
void |
renderXML(org.xml.sax.ContentHandler out,
java.lang.String uid)
Render nothing. |
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 |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static java.util.Map channelStateMap
protected org.apache.commons.logging.Log log
Constructor Detail |
---|
public BaseMultithreadedChannel()
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 renderXML(org.xml.sax.ContentHandler out, java.lang.String uid) throws PortalException
renderXML
in interface IMultithreadedChannel
out
- the content handler to which the channel sends SAX eventsuid
- a unique ID used to identify the state of the channel
PortalException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |