edu.wisc.my.webproxy.beans.filtering
Class PortletUrlFilter

java.lang.Object
  org.xml.sax.helpers.XMLFilterImpl
      edu.wisc.my.webproxy.beans.filtering.ChainingSaxFilter
          edu.wisc.my.webproxy.beans.filtering.BaseUrlFilter
              edu.wisc.my.webproxy.beans.filtering.InclExclUrlFilter
                  edu.wisc.my.webproxy.beans.filtering.PortletUrlFilter

All Implemented Interfaces:

ProxyComponent, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, LexicalHandler, XMLFilter, XMLReader

public final class PortletUrlFilter
extends InclExclUrlFilter

A filter that re-writes all URLs to portlet URLs

Version:

$Id: PortletUrlFilter.java 21818 2010-09-29 19:43:17Z edalquist $

Author:

dgrimwood

Constructor Summary

PortletUrlFilter()

PortletUrlFilter(XMLReader parent)

Method Summary

void	clearData() Called at the end of a request that the component was used in.
protected String	doUrlRewite(String orignialUrl, int matchIndex, boolean passThrough) Rewrite URLs that match the RegEx and INCLUDE/EXCLUDE criteria.
String	getName() Returns a displayable name for the component.
void	setActionData(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) This method is called on a component that is being used by the portlet at the begining of the action request it will be used in.
void	setRenderData(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) This method is called on a component that is being used by the portlet at the begining of the render request it will be used in.

Methods inherited from class edu.wisc.my.webproxy.beans.filtering.InclExclUrlFilter

getListType, getUrlRegExList, rewriteUrl, setListType, setUrlRegExList

Methods inherited from class edu.wisc.my.webproxy.beans.filtering.BaseUrlFilter

characters, endElement, makeCaseInsensitive, setElements, setPassThroughElements, startElement

Methods inherited from class edu.wisc.my.webproxy.beans.filtering.ChainingSaxFilter

comment, endCDATA, endDTD, endEntity, getLexicalHandler, parse, parse, setLexicalHandler, setParent, startCDATA, startDTD, startEntity

Methods inherited from class org.xml.sax.helpers.XMLFilterImpl

endDocument, endPrefixMapping, error, fatalError, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getFeature, getParent, getProperty, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setContentHandler, setDocumentLocator, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletUrlFilter

public PortletUrlFilter()

PortletUrlFilter

public PortletUrlFilter(XMLReader parent)

Method Detail

doUrlRewite

protected String doUrlRewite(String orignialUrl,
                             int matchIndex,
                             boolean passThrough)

Description copied from class: InclExclUrlFilter

Rewrite URLs that match the RegEx and INCLUDE/EXCLUDE criteria.

Specified by:

doUrlRewite in class InclExclUrlFilter

Parameters:

orignialUrl - The URL to re-write

Returns:

The re-written URL.

setRenderData

public void setRenderData(javax.portlet.RenderRequest request,
                          javax.portlet.RenderResponse response)

Description copied from interface: ProxyComponent

This method is called on a component that is being used by the portlet at the begining of the render request it will be used in. It provides the component with a reference to the request and response objects to use.

Specified by:

setRenderData in interface ProxyComponent

Overrides:

setRenderData in class ChainingSaxFilter

clearData

public void clearData()

Description copied from interface: ProxyComponent

Called at the end of a request that the component was used in. It clears the references to the request and response objects. It should be called from a finally block to ensure its execution.

Specified by:

clearData in interface ProxyComponent

Overrides:

clearData in class BaseUrlFilter

getName

public String getName()

Description copied from interface: ProxyComponent

Returns a displayable name for the component.

setActionData

public void setActionData(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)

Description copied from interface: ProxyComponent

This method is called on a component that is being used by the portlet at the begining of the action request it will be used in. It provides the component with a reference to the request and response objects to use.

Specified by:

setActionData in interface ProxyComponent

Overrides:

setActionData in class ChainingSaxFilter