org.apache.pluto.driver.services.container
Class FilterChainImpl

java.lang.Object
  extended by org.apache.pluto.driver.services.container.FilterChainImpl
All Implemented Interfaces:
FilterChain

public class FilterChainImpl
extends java.lang.Object
implements FilterChain

A FilterChain is an object provided by the portlet container to the developer giving a view into the invocation chain of a filtered request for a portlet. Filters use the FilterChain to invoke the next filter in the chain, or if the calling filter is the last filter in the chain, to invoke the portlet at the end of the chain.

Since:
29/05/2007
Version:
2.0

Constructor Summary
FilterChainImpl(java.lang.String appName)
           
 
Method Summary
 void addFilter(java.lang.String className, FilterConfigImpl filterConfig, java.util.List<java.lang.String> portletNames, java.util.List lifecycle)
          Adds the filter to the filterChain
 void doFilter(ActionRequest request, ActionResponse response)
          Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
 void doFilter(EventRequest request, EventResponse response)
          Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
 void doFilter(RenderRequest request, RenderResponse response)
          Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
 void doFilter(ResourceRequest request, ResourceResponse response)
          Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.
 java.lang.String getAppName()
          Gets the application name.
 int getIndex()
           
 void setFilterData(java.lang.ClassLoader loader, java.lang.String portletName, PortletContext portletContext)
          The filterData has do be set before call doFilter.
 void setIndex(int index)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterChainImpl

public FilterChainImpl(java.lang.String appName)
Method Detail

setFilterData

public void setFilterData(java.lang.ClassLoader loader,
                          java.lang.String portletName,
                          PortletContext portletContext)
The filterData has do be set before call doFilter.

Parameters:
loader - Classloader of the appl.
portletName -
portletContext -

addFilter

public void addFilter(java.lang.String className,
                      FilterConfigImpl filterConfig,
                      java.util.List<java.lang.String> portletNames,
                      java.util.List lifecycle)
Adds the filter to the filterChain

Parameters:
className - Path to the filter
filterConfig -
portletNames -
lifecycle -

doFilter

public void doFilter(ActionRequest request,
                     ActionResponse response)
              throws java.io.IOException,
                     PortletException
Description copied from interface: FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

Specified by:
doFilter in interface FilterChain
Parameters:
request - the current action request.
response - the current action response
Throws:
java.io.IOException - if an IO error occured in the filter processing
PortletException - if a portlet exception occured in the filter processing

doFilter

public void doFilter(EventRequest request,
                     EventResponse response)
              throws java.io.IOException,
                     PortletException
Description copied from interface: FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

Specified by:
doFilter in interface FilterChain
Parameters:
request - the current event request.
response - the current event response.
Throws:
java.io.IOException - if an IO error occured in the filter processing
PortletException - if a portlet exception occured in the filter processing

doFilter

public void doFilter(RenderRequest request,
                     RenderResponse response)
              throws java.io.IOException,
                     PortletException
Description copied from interface: FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

Specified by:
doFilter in interface FilterChain
Parameters:
request - the current render request.
response - the current render response.
Throws:
java.io.IOException - if an IO error occured in the filter processing
PortletException - if a portlet exception occured in the filter processing

doFilter

public void doFilter(ResourceRequest request,
                     ResourceResponse response)
              throws java.io.IOException,
                     PortletException
Description copied from interface: FilterChain
Causes the next filter in the chain to be invoked, or if the calling filter is the last filter in the chain, causes the portlet at the end of the chain to be invoked.

Specified by:
doFilter in interface FilterChain
Parameters:
request - the current resource request.
response - the current resource response.
Throws:
java.io.IOException - if an IO error occured in the filter processing
PortletException - if a portlet exception occured in the filter processing

getAppName

public java.lang.String getAppName()
Gets the application name.

Returns:
application name

getIndex

public int getIndex()

setIndex

public void setIndex(int index)


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.