| java.lang.Object
 org.jasig.portal.ChannelRenderer
| Inner Class :protected class Worker extends BaseTask | |
| CACHE_CHANNELS | | final public static boolean CACHE_CHANNELS(Code) | | |
| ccacheable | | protected boolean ccacheable(Code) | | |
| donerendering | | protected boolean donerendering(Code) | | |
| log | | final protected Log log(Code) | | |
| rendering | | protected boolean rendering(Code) | | |
| renderingStatus | | final public static String[] renderingStatus(Code) | | |
| startTime | | protected long startTime(Code) | | |
| systemCache | | protected static Map systemCache(Code) | | |
| timeOut | | protected long timeOut(Code) | | |
| tp | | protected static ExecutorService tp(Code) | | |
| workTracker | | protected Future workTracker(Code) | | |
| worker | | protected Worker worker(Code) | | |
| ChannelRenderer | | public ChannelRenderer(IChannel chan, ChannelRuntimeData runtimeData, PortalControlStructures pcs, ExecutorService threadPool)(Code) | | Default contstructor
Parameters:
chan - an IChannel value
Parameters:
runtimeData - a ChannelRuntimeData value
Parameters:
threadPool - a ThreadPool value |
| ChannelRenderer | | public ChannelRenderer(IChannel chan, ChannelRuntimeData runtimeData, PortalControlStructures pcs, ExecutorService threadPool, SetCheckInSemaphore groupSemaphore, Object groupRenderingKey)(Code) | | Default contstructor
Parameters:
chan - an IChannel value
Parameters:
runtimeData - a ChannelRuntimeData value
Parameters:
threadPool - a ThreadPool value
Parameters:
groupSemaphore - a SetCheckInSemaphore for the current rendering group
Parameters:
groupRenderingKey - an Object to be used for check ins with the group semaphore |
| cancelRendering | | public void cancelRendering()(Code) | | Cancels the rendering job.
|
| completeRendering | | public int completeRendering() throws Throwable(Code) | | Requests renderer to complete rendering and return status.
This does exactly the same things as outputRendering except for the
actual stream output.
an int return status value |
| getBuffer | | public SAX2BufferImpl getBuffer()(Code) | | Returns rendered buffer.
This method does not perform any status checks, so make sure to call completeRendering() prior to invoking this method.
rendered buffer |
| getChannelCache | | Map getChannelCache()(Code) | | Obtains a content cache specific for this channel instance.
a key->rendering map for this channel |
| getCharacters | | public String getCharacters()(Code) | | Returns a character output of a channel rendering.
|
| kill | | protected void kill()(Code) | | This method suppose to take care of the runaway rendering threads.
This method will be called from ChannelManager explictly.
|
| outputRendering | | public int outputRendering(ContentHandler out) throws Throwable(Code) | | Output channel rendering through a given ContentHandler.
Note: call of outputRendering() without prior call to startRendering() is equivalent to
sequential calling of startRendering() and then outputRendering().
outputRendering() is a blocking function. It will return only when the channel completes rendering
or fails to render by exceeding allowed rendering time.
Parameters:
out - Document Handler that will receive information rendered by the channel. error code. 0 - successful rendering; 1 - rendering failed; 2 - rendering timedOut; |
| setCacheTables | | public void setCacheTables(Map cacheTables)(Code) | | |
| setChannel | | public void setChannel(IChannel channel)(Code) | | Sets the channel on which ChannelRenderer is to operate.
Parameters:
channel - an IChannel |
| setCharacterCache | | public void setCharacterCache(String chars)(Code) | | Sets a character cache for the current rendering.
|
| setCharacterCacheable | | public void setCharacterCacheable(boolean setting)(Code) | | Informs IChannelRenderer that a character caching scheme
will be used for the current rendering.
Parameters:
setting - a boolean value |
| setTimeout | | public void setTimeout(long value)(Code) | | Set the timeout value
Parameters:
value - timeout in milliseconds |
| startRendering | | public void startRendering()(Code) | | Start rendering of the channel in a new thread.
Note that rendered information will be accumulated in a
buffer until outputRendering() function is called.
startRendering() is a non-blocking function.
|
|
|