edu.wisc.my.webproxy.beans.config
Interface ProxyComponent

All Known Subinterfaces:

HtmlParser

All Known Implementing Classes:

AbsoluteUrlFilter, BaseUrlFilter, ChainingSaxFilter, ClippingFilter, FuncNameUrlFilter, HtmlOutputFilter, HttpManager, HttpManagerImpl, InclExclUrlFilter, NekoHtmlParser, PortletUrlFilter, ShibbolethEnabledHttpManagerImpl

public interface ProxyComponent

Implemented by classes that can be configured. The interface provides a way to get a list of objects to render configuration pages. Also lets the portlet know if a component is optional and provide the PortletPreferences object during normal operation so the interface can configure itself appropriately.

Method Summary

void	clearData() Called at the end of a request that the component was used in.
String	getName() Returns a displayable name for the component.
void	setActionData(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) This method is called on a component that is being used by the portlet at the begining of the action request it will be used in.
void	setRenderData(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) This method is called on a component that is being used by the portlet at the begining of the render request it will be used in.

Method Detail

getName

String getName()

Returns a displayable name for the component.

setRenderData

void setRenderData(javax.portlet.RenderRequest request,
                   javax.portlet.RenderResponse response)

This method is called on a component that is being used by the portlet at the begining of the render request it will be used in. It provides the component with a reference to the request and response objects to use.

setActionData

void setActionData(javax.portlet.ActionRequest request,
                   javax.portlet.ActionResponse response)

This method is called on a component that is being used by the portlet at the begining of the action request it will be used in. It provides the component with a reference to the request and response objects to use.

clearData

void clearData()

Called at the end of a request that the component was used in. It clears the references to the request and response objects. It should be called from a finally block to ensure its execution.