org.apache.jetspeed.aggregator

Interface PortletContent

public interface PortletContent

Portlet content is a container holding the generated content of a fragment (portlet). It is used by the aggregation engine to abstract access to rendered content per portlet. Content is represented as strings. This interface also supports multi-threaded aggregation, and can be checked to determine if the generation of content has completed. Content can also be cached. Expiration values are represented in this interface.

Version:

$Id: PortletContent.java 1510080 2013-08-03 23:35:19Z taylor $

Author:

Scott T. Weaver, David S. Taylor

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeadElement(HeadElement element, String keyHint) Adds an header element to be contributed to the page.
void	complete() Notifies that this content is completed.
ContentCacheKey	getCacheKey() Get the cache key used to cache this content
String	getContent() Retrieve the actual content of a portlet as a string
String	getContentType() Gets the MIME content type of this portlet content.
int	getExpiration() Get the expiration setting for this content if it is cached.
List<KeyValue<String,HeadElement>>	getHeadElements() Retrieves header element key value pairs to be contributed to the page.
javax.portlet.PortletMode	getPortletMode() Gets the portlet mode of the portlet instance associated with this portlet content.
String	getTitle() Get the cached title of the portlet
javax.portlet.WindowState	getWindowState() Gets the window state of the portlet instance associated with this portlet content.
PrintWriter	getWriter() Get a writer to the content to stream content into this object
boolean	isComplete() Has the renderer completed rendering the content? Used by the multi-threaded (parallel) rendering engine.
void	release() Release the buffers used by the portlet content cache.
void	reset() Reset the buffer of this instance to empty.
void	resetBuffer() Reset the buffer of this instance to empty.
void	setContentType(String contentType) Sets the MIME content type of this portlet content.
void	setExpiration(int expiration) Sets the expiration setting for this content in seconds
void	setTitle(String title) Set the title of this portlet, used during caching

Method Detail

getContent

String getContent()

Retrieve the actual content of a portlet as a string

Returns:

the content of a given fragment (portlet)

isComplete

boolean isComplete()

Has the renderer completed rendering the content? Used by the multi-threaded (parallel) rendering engine.

Returns:

true if the rendering of this fragment's content has completed.

complete

void complete()

Notifies that this content is completed.

getWriter

PrintWriter getWriter()

Get a writer to the content to stream content into this object

Returns:

a writer into this content's stream

getExpiration

int getExpiration()

Get the expiration setting for this content if it is cached.

Returns:

the expiration value in seconds

setExpiration

void setExpiration(int expiration)

Sets the expiration setting for this content in seconds

Parameters:

expiration - the expiration value in seconds

getCacheKey

ContentCacheKey getCacheKey()

Get the cache key used to cache this content

Returns:

the name of the cache key associated with this content

Since:

2.1.2

getTitle

String getTitle()

Get the cached title of the portlet

Returns:

the title of the portlet

setTitle

void setTitle(String title)

Set the title of this portlet, used during caching

Parameters:

title - the title of this portlet

getContentType

String getContentType()

Gets the MIME content type of this portlet content.

Returns:

the MIME content type

setContentType

void setContentType(String contentType)

Sets the MIME content type of this portlet content.

Parameters:

contentType - the MIME content type

getPortletMode

javax.portlet.PortletMode getPortletMode()

Gets the portlet mode of the portlet instance associated with this portlet content.

Returns:

the portlet mode

getWindowState

javax.portlet.WindowState getWindowState()

Gets the window state of the portlet instance associated with this portlet content.

Returns:

the window state

addHeadElement

void addHeadElement(HeadElement element,
                  String keyHint)

Adds an header element to be contributed to the page. If keyHint argument is provided and if a header element with the provided key hint already exists, then the element will be overwritten to the item. If the element is null and keyHint is not null, the element with the keyHint is removed from the response. If the element is not null and keyHint is null, then the keyHint will be automatically generated by the element content. Meanwhile, the element should implement java.io.Serializable. Otherwise it will throw a java.io.NotSerializableException.

Parameters:

element - the header element to contribute to the page

keyHint - the key hint to generate the header element

getHeadElements

List<KeyValue<String,HeadElement>> getHeadElements()

Retrieves header element key value pairs to be contributed to the page. Because the insertion order might be important for web development, it should be list instead of map.

Returns:

list of key value pairs of head element names to HeadElements

reset

void reset()

Reset the buffer of this instance to empty. Also resets all state associated with this content.

resetBuffer

void resetBuffer()

Reset the buffer of this instance to empty. Does not reset state associated with this content.

release

void release()

Release the buffers used by the portlet content cache. Note the actual release may not occur until garbage collection.