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

Class ContentClippingFilter

java.lang.Object

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

All Implemented Interfaces:

IDocumentFilter

@Service(value="contentClippingFilter")
public class ContentClippingFilter
extends Object
implements IDocumentFilter

ContentClippingFilter limits the produced response to a subset of the retrieved document using a jQuery-style selector. This filter can be used to return a portion of a page, for example excluding the header and footer.

Version:

$Id: $Id

Author:

Jen Bourey, jennifer.bourey@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	SELECTOR_KEY Constant SELECTOR_KEY="clippingSelector"

Constructor Summary

Constructors

Constructor and Description
ContentClippingFilter()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

SELECTOR_KEY

public static final String SELECTOR_KEY

Constant SELECTOR_KEY="clippingSelector"

See Also:

Constant Field Values

Constructor Detail

ContentClippingFilter

public ContentClippingFilter()

Method Detail

filter

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

Filter a provided document.

Specified by:

filter in interface IDocumentFilter

Parameters:

document - a Document object

proxyResponse - a IContentResponse object

request - a RenderRequest object

response - a RenderResponse object