org.jasig.portal
Interface IChannelRenderer

All Known Implementing Classes:

ChannelRenderer

Deprecated. IChannel rendering code will be replaced with portlet specific rendering code in a future release

@Deprecated
public interface IChannelRenderer

The IChannelRenderer defines channel rendering interface. The process of channel rendering can be implemented in different ways including in serial form, in parallel form, or a mixture of the two. This interface allows different implementation to use different implementation policies.

The channel renderer interaction model is as follows, in order of invocation:

first startRendering

then completeRendering

and optionally outputRendering

Version:

$Revision: 19776 $

Author:

Jan Nielsen

Field Summary

static int	RENDERING_FAILED Deprecated. Channel rendering failed.
static int	RENDERING_SUCCESSFUL Deprecated. Channel rendering was successful.
static int	RENDERING_TIMED_OUT Deprecated. Channel rendering timed-out.

Method Summary

void	cancelRendering() Deprecated. Cancels the rendering job.
int	completeRendering() Deprecated. Complete the channel rendering.
SAX2BufferImpl	getBuffer() Deprecated. Returns the channel rendering buffer.
String	getCharacters() Deprecated. Returns the channel rendering character set.
long	getRenderTime() Deprecated. This may only be called after outputRendering(ContentHandler) is called.
boolean	isRenderedFromCache() Deprecated. This may only be called after outputRendering(ContentHandler) is called.
void	kill() Deprecated. This method suppose to take care of the runaway rendering threads.
int	outputRendering(ContentHandler out) Deprecated. Places the channel rendering output in the specified content handler.
void	setCacheTables(Map<IChannel,Map<String,ChannelCacheEntry>> cacheTables) Deprecated. Sets the cache tables for the channel renderer.
void	setCharacterCache(String chars) Deprecated. Sets the character cache for the channel renderer.
void	setCharacterCacheable(boolean setting) Deprecated. Enables or disables character caching for the channel renderer.
void	setTimeout(long value) Deprecated. Sets the timeout value for the channel renderer.
void	startRendering() Deprecated. Starts the channel rendering process.
void	startRendering(SetCheckInSemaphore groupSemaphore, Object groupRenderingKey) Deprecated. Starts the channel rendering process.

Field Detail

RENDERING_SUCCESSFUL

static final int RENDERING_SUCCESSFUL

Deprecated.

Channel rendering was successful.

See Also:

Constant Field Values

RENDERING_FAILED

static final int RENDERING_FAILED

Deprecated.

Channel rendering failed.

See Also:

Constant Field Values

RENDERING_TIMED_OUT

static final int RENDERING_TIMED_OUT

Deprecated.

Channel rendering timed-out.

See Also:

Constant Field Values

Method Detail

startRendering

void startRendering()

Deprecated.

Starts the channel rendering process.

startRendering

void startRendering(SetCheckInSemaphore groupSemaphore,
                    Object groupRenderingKey)

Deprecated.

Starts the channel rendering process.

Parameters:

groupSemaphore - semaphore to use for a group of channels

groupRenderingKey - group rendering key

completeRendering

int completeRendering()
                      throws Throwable

Deprecated.

Complete the channel rendering.

Returns:

status code of the channel rendering process

Throws:

Throwable

cancelRendering

void cancelRendering()

Deprecated.

Cancels the rendering job.

kill

void kill()

Deprecated.

This method suppose to take care of the runaway rendering threads.

getCharacters

String getCharacters()

Deprecated.

Returns the channel rendering character set.

Returns:

string representation of the channel rendering characters

getBuffer

SAX2BufferImpl getBuffer()

Deprecated.

Returns the channel rendering buffer.

Returns:

channel rendering buffer

setCharacterCache

void setCharacterCache(String chars)

Deprecated.

Sets the character cache for the channel renderer.

Parameters:

chars - character cache for the channel renderer

setCharacterCacheable

void setCharacterCacheable(boolean setting)

Deprecated.

Enables or disables character caching for the channel renderer.

Parameters:

setting - character caching setting

setCacheTables

void setCacheTables(Map<IChannel,Map<String,ChannelCacheEntry>> cacheTables)

Deprecated.

Sets the cache tables for the channel renderer.

Parameters:

cacheTables - cache table for the channel renderer

setTimeout

void setTimeout(long value)

Deprecated.

Sets the timeout value for the channel renderer.

Parameters:

value - milliseconds of timeout for the channel renderer

outputRendering

int outputRendering(ContentHandler out)
                    throws Throwable

Deprecated.

Places the channel rendering output in the specified content handler.

Parameters:

out - content handler for the channel rendering information

Returns:

status code

Throws:

Throwable - if an error occurs

getRenderTime

long getRenderTime()

Deprecated.

This may only be called after outputRendering(ContentHandler) is called.

Returns:

The time in milliseconds it took for the channel to render

isRenderedFromCache

boolean isRenderedFromCache()

Deprecated.

This may only be called after outputRendering(ContentHandler) is called.

Returns:

If cached content was returned instead of actually rendering the channel