|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterAdapter
public abstract class PortletFilterAdapter
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.
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 |
---|
public PortletFilterAdapter()
Method Detail |
---|
public void init(com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterConfig filterConfig) throws org.apache.jetspeed.portlet.PortletException
The portlet container cannot place the filter into service if
the init method either
init
in interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter
filterConfig
- the portlet filter config
org.apache.jetspeed.portlet.PortletException
- if an exception has occurrred that interferes
with the portlet filter's normal initializationpublic 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
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:
doFilter
in interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter
method
- the type of requested methodrequest
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a LOGIN method.
For this method the response is always NULL.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a BEGINPAGE method.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a SERVICE method.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a ENDPAGE method.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a DOTITLE method.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a ACTIONEVENT method.
For this method the response is always NULL.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a MESSAGEVENT method.
For this method the response is always NULL.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
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
doFilter
method) to
allow a portlet filter to handle a WINDOWEVENT method.
For this method the response is always NULL.
request
- the request to pass along the chain.response
- the response to pass along the chain.chain
- the portlet filter chain
org.apache.jetspeed.portlet.PortletException
- if the filter has trouble fulfilling the request
java.io.IOException
- if the streaming causes an I/O problemPortletFilterChain
public void destroy()
destroy
in interface com.ibm.wps.pe.pc.legacy.cmpf.PortletFilter
public com.ibm.wps.pe.pc.legacy.cmpf.PortletFilterConfig getFilterConfig()
PortletFilterConfig
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |