public interface PortletFilter
PortletFilteris the base interface for all portlet filters. It provides the lifecycle methods
destroyfor putting a portlet filter into and out of service.
|Modifier and Type||Method and Description|
Called by the portlet container to indicate to a filter that it is being taken out of service.
Called by the portlet container to indicate to a filter that it is being placed into service.
void init(FilterConfig filterConfig) throws PortletException
The portlet container cannot place the filter into service if the init method either
filterConfig- the filter configuration data defined in the portlet deployment descriptor
PortletException- if an error occurs in the filter initialization
doFiltermethod have exited or after a timeout period has passed.
After the portlet container calls this method, it will not call the
doFilter method again on this instance of the filter.
This method gives the filter an opportunity to clean up any resources that are being held (for example, memory, file handles, threads) and make sure that any persistent state is synchronized with the filter's current state in memory.
Java Portlet 3.0 API Specification. See the Copyright and License provided with this distribution. Use is subject to license terms.