com.ibm.wps.pe.pc.legacy.cmpf
Class PortletFilterAdapter

java.lang.Object
  com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterAdapter

All Implemented Interfaces:

com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter

public abstract class PortletFilterAdapter
extends java.lang.Object
implements com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter

The PortletFilterAdapter is a default implementation for the PortletFilter interface. It is recommended not to extend the portlet filter interface directly. Rather, a portlet filter should derive from this adapter.

Since:

5.0

See Also:

PortletFilter

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter

com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter.Method

Constructor Summary

PortletFilterAdapter()
Creates a new PortletFilterAdapter.

Method Summary

void	destroy()
void	doActionEvent(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a ACTIONEVENT method.
void	doBeginPage(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a BEGINPAGE method.
void	doEndPage(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a ENDPAGE method.
void	doFilter(com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter.Method method, org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.
void	doLogin(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a LOGIN method.
void	doMessageEvent(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a MESSAGEVENT method.
void	doService(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a SERVICE method.
void	doTitle(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a DOTITLE method.
void	doWindowEvent(org.apache.jetspeed.portlet.PortletRequest request, org.apache.jetspeed.portlet.PortletResponse response, com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain) Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a WINDOWEVENT method.
com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterConfig	getFilterConfig() Returns the FilterConfig for this Filter.
void	init(com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterConfig filterConfig) Called by the portlet container to indicate to a filter that it is being placed into service.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletFilterAdapter

public PortletFilterAdapter()

Creates a new PortletFilterAdapter.

Method Detail

init

public void init(com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterConfig filterConfig)
          throws org.apache.jetspeed.portlet.PortletException

Called by the portlet container to indicate to a filter that it is being placed into service. The portlet container calls the init method exactly once after instantiating the filter.
The init method must complete successfully before the filter is asked to do any filtering work.

The portlet container cannot place the filter into service if the init method either

1. Throws a PortletException
2. Does not return within a time period defined by the portlet container

Specified by:

init in interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter

Parameters:

filterConfig - the portlet filter config

Throws:

org.apache.jetspeed.portlet.PortletException - if an exception has occurrred that interferes with the portlet filter's normal initialization

doFilter

public void doFilter(com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter.Method method,
                     org.apache.jetspeed.portlet.PortletRequest request,
                     org.apache.jetspeed.portlet.PortletResponse response,
                     com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
              throws org.apache.jetspeed.portlet.PortletException,
                     java.io.IOException

The doFilter method of the Filter is called by the container each time a request/response pair is passed through the chain due to a client request for a resource at the end of the chain.

Please note that the response may be null for an event-based method, e.g., ActionEvent.

The FilterChain passed in to this method allows the Filter to pass on the request and response to the next entity in the chain.

A typical implementation of this method would follow the following pattern:

1. Examine the request
2. Optionally wrap the request object with a custom implementation to filter content or headers for input filtering
3. Optionally wrap the response object with a custom implementation to filter content or headers for output filtering
4. a) Either invoke the next entity in the chain using the FilterChain object (chain.doFilter()),
5. b) or not pass on the request/response pair to the next entity in the filter chain to block the request processing

Specified by:

doFilter in interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter

Parameters:

method - the type of requested method

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doLogin

public void doLogin(org.apache.jetspeed.portlet.PortletRequest request,
                    org.apache.jetspeed.portlet.PortletResponse response,
                    com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
             throws org.apache.jetspeed.portlet.PortletException,
                    java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a LOGIN method. For this method the response is always NULL.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doBeginPage

public void doBeginPage(org.apache.jetspeed.portlet.PortletRequest request,
                        org.apache.jetspeed.portlet.PortletResponse response,
                        com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
                 throws org.apache.jetspeed.portlet.PortletException,
                        java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a BEGINPAGE method.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doService

public void doService(org.apache.jetspeed.portlet.PortletRequest request,
                      org.apache.jetspeed.portlet.PortletResponse response,
                      com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
               throws org.apache.jetspeed.portlet.PortletException,
                      java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a SERVICE method.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doEndPage

public void doEndPage(org.apache.jetspeed.portlet.PortletRequest request,
                      org.apache.jetspeed.portlet.PortletResponse response,
                      com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
               throws org.apache.jetspeed.portlet.PortletException,
                      java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a ENDPAGE method.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doTitle

public void doTitle(org.apache.jetspeed.portlet.PortletRequest request,
                    org.apache.jetspeed.portlet.PortletResponse response,
                    com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
             throws org.apache.jetspeed.portlet.PortletException,
                    java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a DOTITLE method.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doActionEvent

public void doActionEvent(org.apache.jetspeed.portlet.PortletRequest request,
                          org.apache.jetspeed.portlet.PortletResponse response,
                          com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
                   throws org.apache.jetspeed.portlet.PortletException,
                          java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a ACTIONEVENT method. For this method the response is always NULL.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doMessageEvent

public void doMessageEvent(org.apache.jetspeed.portlet.PortletRequest request,
                           org.apache.jetspeed.portlet.PortletResponse response,
                           com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
                    throws org.apache.jetspeed.portlet.PortletException,
                           java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a MESSAGEVENT method. For this method the response is always NULL.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

doWindowEvent

public void doWindowEvent(org.apache.jetspeed.portlet.PortletRequest request,
                          org.apache.jetspeed.portlet.PortletResponse response,
                          com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterChain chain)
                   throws org.apache.jetspeed.portlet.PortletException,
                          java.io.IOException

Called by the portlet container (via the doFilter method) to allow a portlet filter to handle a WINDOWEVENT method. For this method the response is always NULL.

Parameters:

request - the request to pass along the chain.

response - the response to pass along the chain.

chain - the portlet filter chain

Throws:

org.apache.jetspeed.portlet.PortletException - if the filter has trouble fulfilling the request

java.io.IOException - if the streaming causes an I/O problem

See Also:

PortletFilterChain

destroy

public void destroy()

Specified by:

destroy in interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter

getFilterConfig

public com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterConfig getFilterConfig()

Returns the FilterConfig for this Filter.

Returns:

the filter config

See Also:

PortletFilterConfig