|
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.ChannelRenderer
This class takes care of initiating channel rendering thread, monitoring it for timeouts, retreiving cache, and returning rendering results and status.
Field Summary | |
static boolean |
CACHE_CHANNELS
|
static int |
RENDERING_FAILED
|
static int |
RENDERING_SUCCESSFUL
|
static int |
RENDERING_TIMED_OUT
|
static java.lang.String[] |
renderingStatus
|
Fields inherited from interface org.jasig.portal.IChannelRenderer |
RCS_ID |
Constructor Summary | |
ChannelRenderer(IChannel chan,
ChannelRuntimeData runtimeData,
ThreadPool threadPool)
Default contstructor |
|
ChannelRenderer(IChannel chan,
ChannelRuntimeData runtimeData,
ThreadPool threadPool,
SetCheckInSemaphore groupSemaphore,
java.lang.Object groupRenderingKey)
Default contstructor |
Method Summary | |
void |
cancelRendering()
Cancels the rendering job. |
int |
completeRendering()
Requests renderer to complete rendering and return status. |
SAX2BufferImpl |
getBuffer()
Returns rendered buffer. |
java.lang.String |
getCharacters()
Returns a character output of a channel rendering. |
int |
outputRendering(org.xml.sax.ContentHandler out)
Output channel rendering through a given ContentHandler. |
void |
setCacheTables(java.util.Map cacheTables)
Sets the cache tables for the channel renderer. |
void |
setChannel(IChannel channel)
Sets the channel on which ChannelRenderer is to operate. |
void |
setCharacterCache(java.lang.String chars)
Sets a character cache for the current rendering. |
void |
setCharacterCacheable(boolean setting)
Informs IChannelRenderer that a character caching scheme will be used for the current rendering. |
void |
setTimeout(long value)
Set the timeout value |
void |
startRendering()
Start rendering of the channel in a new thread. |
void |
startRendering(SetCheckInSemaphore groupSemaphore,
java.lang.Object groupRenderingKey)
Starts the channel rendering process. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final boolean CACHE_CHANNELS
public static final int RENDERING_SUCCESSFUL
public static final int RENDERING_FAILED
public static final int RENDERING_TIMED_OUT
public static final java.lang.String[] renderingStatus
Constructor Detail |
public ChannelRenderer(IChannel chan, ChannelRuntimeData runtimeData, ThreadPool threadPool)
chan
- an IChannel
valueruntimeData
- a ChannelRuntimeData
valuethreadPool
- a ThreadPool
valuepublic ChannelRenderer(IChannel chan, ChannelRuntimeData runtimeData, ThreadPool threadPool, SetCheckInSemaphore groupSemaphore, java.lang.Object groupRenderingKey)
chan
- an IChannel
valueruntimeData
- a ChannelRuntimeData
valuethreadPool
- a ThreadPool
valuegroupSemaphore
- a SetCheckInSemaphore
for the current rendering groupgroupRenderingKey
- an Object
to be used for check ins with the group semaphoreMethod Detail |
public void setChannel(IChannel channel)
channel
- an IChannel
public void setTimeout(long value)
setTimeout
in interface IChannelRenderer
value
- timeout in millisecondspublic void setCacheTables(java.util.Map cacheTables)
IChannelRenderer
Sets the cache tables for the channel renderer.
setCacheTables
in interface IChannelRenderer
cacheTables
- cache table for the channel rendererpublic void setCharacterCacheable(boolean setting)
setCharacterCacheable
in interface IChannelRenderer
setting
- a boolean
valuepublic void startRendering()
startRendering
in interface IChannelRenderer
public void startRendering(SetCheckInSemaphore groupSemaphore, java.lang.Object groupRenderingKey)
IChannelRenderer
Starts the channel rendering process.
startRendering
in interface IChannelRenderer
groupSemaphore
- semaphore to use for a group of channelsgroupRenderingKey
- group rendering keypublic void cancelRendering()
Cancels the rendering job.
cancelRendering
in interface IChannelRenderer
public int outputRendering(org.xml.sax.ContentHandler out) throws java.lang.Throwable
outputRendering
in interface IChannelRenderer
out
- Document Handler that will receive information rendered by the channel.
java.lang.Throwable
- if an error occurspublic int completeRendering() throws java.lang.Throwable
completeRendering
in interface IChannelRenderer
int
return status value
java.lang.Throwable
public SAX2BufferImpl getBuffer()
getBuffer
in interface IChannelRenderer
public java.lang.String getCharacters()
getCharacters
in interface IChannelRenderer
public void setCharacterCache(java.lang.String chars)
setCharacterCache
in interface IChannelRenderer
chars
- character cache for the channel renderer
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |