org.apache.pluto.invoker

Interface PortletInvoker

All Known Implementing Classes:

PortletInvokerImpl

public interface PortletInvoker

This interface defines the operations required by the Pluto container in order to invoke portlets. Portlet invokers are defined by three operations: action, render, and optionally load. The container delegates the actual implementation of these operations to the portal. The action method will invoke the processAction method on the javax.portlet.Portlet interface of a portlet. The render method will invoke the render method on the javax.portlet.Portlet interface of a portlet.

Version:

$Id: PortletInvoker.java 35916 2004-03-02 14:55:19Z cziegeler $

Method Summary

Methods

Modifier and Type	Method and Description
void	action(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) This method invokes the processAction method of a Java portlet (javax.portlet.Portlet).
void	load(javax.portlet.PortletRequest request, javax.portlet.RenderResponse response) This method invokes the optional load method of a portlet if supported.
void	render(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) This method invokes the render method of a Java portlet (javax.portlet.Portlet).

Method Detail

action

void action(javax.portlet.ActionRequest request,
          javax.portlet.ActionResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException

This method invokes the processAction method of a Java portlet (javax.portlet.Portlet).

Parameters:

request - Represents the request sent to a portlet to handle an action.

response - Represents the response provide by a portlet in handling an action.

Throws:

javax.portlet.PortletException

java.io.IOException

render

void render(javax.portlet.RenderRequest request,
          javax.portlet.RenderResponse response)
            throws javax.portlet.PortletException,
                   java.io.IOException

This method invokes the render method of a Java portlet (javax.portlet.Portlet).

Parameters:

request - Represents the request sent to a portlet to handle rendering the portlet.

response - Represents the response provide by a portlet in rendering.

Throws:

javax.portlet.PortletException

java.io.IOException

load

void load(javax.portlet.PortletRequest request,
        javax.portlet.RenderResponse response)
          throws javax.portlet.PortletException

This method invokes the optional load method of a portlet if supported. This method is not yet standardized.

Parameters:

request - Represents the request sent to a portlet to handle initializing the portlet.

response - Represents the response sent to a portlet to handle initializing the portlet.

Throws:

javax.portlet.PortletException