ToolRenderService.java

package org.sakaiproject.portal.render.api;

import java.io.IOException;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.sakaiproject.portal.api.Portal;
import org.sakaiproject.site.api.ToolConfiguration;

/**
 * Service responsible for preprocessing and rendering tools within a Sakai
 * portal.
 * 
 * @since Sakai 2.2.3
 * @version $Rev: 35170 $
 */
public interface ToolRenderService
{

	/**
	 * Perfrorm any preperatory processing for the specified tool.
	 * 
	 * @param request
	 *        the servlet request
	 * @param response
	 *        the servlet response.
	 * @param context
	 *        the portal servlet context
	 * @return indicates whether or not processing should be continued.
	 * @throws IOException
	 *         if an error occurs during preprocessing.
	 */
	boolean preprocess(Portal portal, HttpServletRequest request, HttpServletResponse response,
			ServletContext context) throws IOException;

	/**
	 * Render the tool.
	 * 
	 * @param toolConfiguration
	 * @param request
	 * @param response
	 * @throws IOException
	 * @throws ToolRenderException
	 */
	RenderResult render(Portal portal, ToolConfiguration toolConfiguration, HttpServletRequest request,
			HttpServletResponse response, ServletContext context) throws IOException,
			ToolRenderException;

	/**
	 * The render service will accept responsibility for a tool. This enables a
	 * controller to check if the render service can manage the tool
	 * 
	 * @param configuration
	 *        tool configuration for the tool in question
	 * @param request
	 * @param response
	 * @param context -
	 *        this is the servlet context handling the request (ie the portal)
	 * @return
	 */
	boolean accept(Portal portal, ToolConfiguration configuration, HttpServletRequest request,
			HttpServletResponse response, ServletContext context);

	/**
	 * reset the ToolConfiguration/Placement associated with the config
	 * 
	 * @param configuration
	 */
	void reset( ToolConfiguration configuration);

}