org.apache.portals.applications.webcontent2.proxy.filter

Class GenericReverseProxyFilter

java.lang.Object

org.apache.portals.applications.webcontent2.proxy.filter.GenericReverseProxyFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

SimpleReverseProxyFilter

public class GenericReverseProxyFilter
extends Object
implements javax.servlet.Filter

Generic reverse proxy servlet filter invoking ReverseProxyService injected.

Unlike servlets, servlet filters cannot know the filter mapping path prefix by itself. So, this filter should be configured with filterPath init parameters in order to get the link rewriting and redirection done properly with the prefix. For example, if this filter is mapped to '/rproxyfilter/*', then you should add an init parameter like the following:

<init-param> <param-name>filterPath</param-name> <param-value>/rproxyfilter</param-value> </init-param>

Constructor Summary

Constructors

Constructor and Description
GenericReverseProxyFilter() Zero-argument default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Destroys this servlet filter.
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain) Invokes the internal ReverseProxyService on allowed HTTP requests.
protected javax.servlet.FilterConfig	getFilterConfig() Returns the FilterConfig of this servlet filter.
protected String	getFilterPath() Returns the servlet filter mapping path prefix.
ReverseProxyService	getProxyService() Returns the internal ReverseProxyService instance.
protected String	getRequestBasePath(javax.servlet.http.HttpServletRequest request) Returns the concatenation of the servlet context path (see ServletContext.getContext(String) and the filterPath (see getFilterPath()).
void	init(javax.servlet.FilterConfig filterConfig) Initializes this servlet filter.
void	setProxyService(ReverseProxyService proxyService) Sets the internal ReverseProxyService instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericReverseProxyFilter

public GenericReverseProxyFilter()

Zero-argument default constructor.

Method Detail

getProxyService

public ReverseProxyService getProxyService()

Returns the internal ReverseProxyService instance.

Returns:

setProxyService

public void setProxyService(ReverseProxyService proxyService)

Sets the internal ReverseProxyService instance.

Parameters:

proxyService -

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Initializes this servlet filter.

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest req,
            javax.servlet.ServletResponse res,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Invokes the internal ReverseProxyService on allowed HTTP requests.

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Destroys this servlet filter.

Specified by:

destroy in interface javax.servlet.Filter

getFilterConfig

protected javax.servlet.FilterConfig getFilterConfig()

Returns the FilterConfig of this servlet filter.

Returns:

getFilterPath

protected String getFilterPath()

Returns the servlet filter mapping path prefix. For example, if the servlet filter is mapped to '/rproxyfilter/*', then this method is supposed to return '/rproxyfilter'.

Returns:

getRequestBasePath

protected String getRequestBasePath(javax.servlet.http.HttpServletRequest request)

Returns the concatenation of the servlet context path (see ServletContext.getContext(String) and the filterPath (see getFilterPath()).