edu.wisc.my.webproxy.beans.config

Interface ConfigPage

All Known Implementing Classes:

CacheConfigImpl, ClippingConfigImpl, GeneralConfigImpl, HtmlParserConfigImpl, HttpClientConfigImpl, HttpHeaderConfigImpl, JspConfigPage, StaticHtmlConfigImpl

public interface ConfigPage

Represents a configuration page to be displayed during the portlet's configuration. The render method is called to render the page's markup and process is called when the configuration page is submitted. The implementation is expected to use the PortletPreferences object to persist its configuration. Preference names should be created using the standard java package naming scheme to avoid collisions.

Version:

$Id$

Author:

dgrimwood

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns a displayable title for the configuration page.
void	process(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) Called by the portlet when the submitted configuration page was for this object.
void	render(javax.portlet.PortletContext context, javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) Called by the portlet when the page should render its configuration UI.

Method Detail

getName

String getName()

Returns a displayable title for the configuration page. This title is used when the portlet renders the workflow portion of the configuration UI.

render

void render(javax.portlet.PortletContext context,
          javax.portlet.RenderRequest request,
          javax.portlet.RenderResponse response)
            throws IOException,
                   javax.portlet.PortletException

Called by the portlet when the page should render its configuration UI.

Parameters:

context -

request -

response -

Throws:

IOException

javax.portlet.PortletException

process

void process(javax.portlet.ActionRequest request,
           javax.portlet.ActionResponse response)
             throws javax.portlet.PortletException,
                    IOException,
                    edu.wisc.my.webproxy.beans.config.ConfigurationException

Called by the portlet when the submitted configuration page was for this object. This is where the page should persist its settings using the PortletPreferences API. This may throw a ConfigurationException if the submitted data is incorrect

Parameters:

request -

response -

Throws:

javax.portlet.PortletException

IOException

ConfigurationException