|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceFilter
The ResourceFilter
is an object that performs filtering
tasks on either the resource request to a portlet, or on the resource response from
a portlet, or both.
Filters perform filtering in the doFilter
method. Every Filter has
access to a FilterConfig
object from which it can obtain
its initialization parameters, a reference to the PortletContext
which it can use, for example, to load resources needed for filtering tasks.
Filters are configured in the portlet deployment descriptor of a portlet application.
Method Summary | |
---|---|
void |
doFilter(ResourceRequest request,
ResourceResponse response,
FilterChain chain)
The doFilter method of the Filter is called by the
portlet container each time a resource request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain. |
Methods inherited from interface javax.portlet.filter.PortletFilter |
---|
destroy, init |
Method Detail |
---|
void doFilter(ResourceRequest request, ResourceResponse response, FilterChain chain) throws java.io.IOException, PortletException
doFilter
method of the Filter is called by the
portlet container each time a resource request/response pair is passed
through the chain due to a client request for a portlet method
at the end of the chain.
The FilterChain
passed in to this method allows
the Filter to pass on the resource request and response to the next
component in the chain.
The doFilter
method of a filter will typically be implemented
following this or some subset of the following pattern:
ResourceRequestWrapper
in order to modify request data.doFilter
method with a customized implementation
of the response wrapper ResourceResponseWrapper
to modify response data.doFilter
method on the FilterChain
object, and passing in
the request and response with which it was called or passing
in wrapped versions it may have created.
The filter chain’s implementation of the doFilter
method, provided by the portlet container, must locate the
next component in the filter chain and invoke its doFilter
method, passing in the appropriate request and response objects.
Alternatively, the filter chain can block the request by not
making the call to invoke the next component, leaving the filter
responsible for filling out the response object.UnavailableException
during its doFilter
processing, the portlet container must not attempt continued
processing down the filter chain. It may choose to retry the
whole chain at a later time if the exception is not marked permanent.
request
- the current resource requestresponse
- the current resource responsechain
- the remaining filter chain
java.io.IOException
- if an IO error occurred in the filter processing
PortletException
- if a portlet exception occurred in the filter processing
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |