org.jasig.portlet.proxy.service.proxy.document

Class HeaderFooterFilter

java.lang.Object

org.jasig.portlet.proxy.service.proxy.document.HeaderFooterFilter

All Implemented Interfaces:

IDocumentFilter

@Service(value="headerFooterFilter")
public class HeaderFooterFilter
extends Object
implements IDocumentFilter

HeaderFooterFilter can add static HTML header and footer content to any proxied content.

Version:

$Id: $Id

Author:

Jen Bourey

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOOTER_KEY Constant FOOTER_KEY="footerHtml"
static String	HEADER_KEY Constant HEADER_KEY="headerHtml"

Constructor Summary

Constructors

Constructor and Description
HeaderFooterFilter()

Method Summary

Modifier and Type	Method and Description
void	filter(org.jsoup.nodes.Document document, IContentResponse proxyResponse, javax.portlet.RenderRequest portletRequest, javax.portlet.RenderResponse portletResponse) Filter a provided document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HEADER_KEY

public static final String HEADER_KEY

Constant HEADER_KEY="headerHtml"

See Also:

Constant Field Values

FOOTER_KEY

public static final String FOOTER_KEY

Constant FOOTER_KEY="footerHtml"

See Also:

Constant Field Values

Constructor Detail

HeaderFooterFilter

public HeaderFooterFilter()

Method Detail

filter

public void filter(org.jsoup.nodes.Document document,
                   IContentResponse proxyResponse,
                   javax.portlet.RenderRequest portletRequest,
                   javax.portlet.RenderResponse portletResponse)

Filter a provided document.

Specified by:

filter in interface IDocumentFilter

Parameters:

document - a Document object

proxyResponse - a IContentResponse object

portletRequest - a RenderRequest object

portletResponse - a RenderResponse object