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

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

All Implemented Interfaces:

ProxyComponent, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler, org.xml.sax.ext.LexicalHandler, org.xml.sax.XMLFilter, org.xml.sax.XMLReader

Direct Known Subclasses:

FuncNameUrlFilter, PortletUrlFilter

public abstract class InclExclUrlFilter
extends BaseUrlFilter

Version:

$Id: InclExclUrlFilter.java 12215 2006-11-15 22:55:32Z edalquist $

Author:

Eric Dalquist edalquist@unicon.net

Constructor Summary

InclExclUrlFilter()

InclExclUrlFilter(org.xml.sax.XMLReader parent)

Method Summary

protected abstract java.lang.String	doUrlRewite(java.lang.String orignialUrl, int matchIndex) Rewrite URLs that match the RegEx and INCLUDE/EXCLUDE criteria.
protected java.lang.String	getListType()
protected java.lang.String[]	getUrlRegExList()
java.lang.String	rewriteUrl(java.lang.String originalUrl) Abstract method for re-writng a given url
protected void	setListType(java.lang.String listType)
protected void	setUrlRegExList(java.lang.String[] urlRegExList)

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

characters, clearData, endElement, setElements, startElement

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

comment, endCDATA, endDTD, endEntity, getLexicalHandler, parse, parse, setActionData, setLexicalHandler, setParent, setRenderData, 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

Methods inherited from interface edu.wisc.my.webproxy.beans.config.ProxyComponent

getName

Constructor Detail

InclExclUrlFilter

public InclExclUrlFilter()

InclExclUrlFilter

public InclExclUrlFilter(org.xml.sax.XMLReader parent)

Method Detail

rewriteUrl

public final java.lang.String rewriteUrl(java.lang.String originalUrl)

Description copied from class: BaseUrlFilter

Abstract method for re-writng a given url

Specified by:

rewriteUrl in class BaseUrlFilter

Parameters:

originalUrl - the url as a String before it is re-written to some other url

Returns:

sTempAtt the url as a String after it is re-written to some other url

getListType

protected java.lang.String getListType()

Returns:

Returns the listType.

setListType

protected void setListType(java.lang.String listType)

Parameters:

listType - The listType to set.

getUrlRegExList

protected java.lang.String[] getUrlRegExList()

Returns:

Returns the urlRegExList.

setUrlRegExList

protected void setUrlRegExList(java.lang.String[] urlRegExList)

Parameters:

urlRegExList - The urlRegExList to set.

doUrlRewite

protected abstract java.lang.String doUrlRewite(java.lang.String orignialUrl,
                                                int matchIndex)

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

Parameters:

orignialUrl - The URL to re-write

Returns:

The re-written URL.