org.apache.jetspeed.container.invoker
Interface JetspeedPortletInvoker

All Superinterfaces:

org.apache.pluto.invoker.PortletInvoker

All Known Implementing Classes:

LocalPortletInvoker, ServletPortletInvoker

public interface JetspeedPortletInvoker
extends org.apache.pluto.invoker.PortletInvoker

JetspeedPortletInvoker extends Pluto's portlet invoker and extends it with lifecycle management. Portlet Invokers can be pooled, and activated and passivated per request cycle.

Version:

$Id: JetspeedPortletInvoker.java 516448 2007-03-09 16:25:47Z ate $

Author:

David Sean Taylor

Method Summary

void	activate(org.apache.jetspeed.factory.PortletFactory portletFactory, org.apache.pluto.om.portlet.PortletDefinition portletDefinition, javax.servlet.ServletConfig servletConfig) Activating an invoker makes it ready to invoke portlets.
void	activate(org.apache.jetspeed.factory.PortletFactory portletFactory, org.apache.pluto.om.portlet.PortletDefinition portletDefinition, javax.servlet.ServletConfig servletConfig, String property) Activating an invoker makes it ready to invoke portlets.
boolean	isActivated() Returns true if the state of this invoke is 'activated', and false if it is 'passivated'.
void	passivate() Passivates an invoker, freeing it back to the invoker pool.

Methods inherited from interface org.apache.pluto.invoker.PortletInvoker

action, load, render

Method Detail

activate

void activate(org.apache.jetspeed.factory.PortletFactory portletFactory,
              org.apache.pluto.om.portlet.PortletDefinition portletDefinition,
              javax.servlet.ServletConfig servletConfig)

Activating an invoker makes it ready to invoke portlets. If an invoker's state is not activated, it can not invoke.

Parameters:

portletFactory - The factory to get access to the portlet being invoked.

portletDefinition - The portlet's definition that is being invoked.

servletConfig - The servlet configuration of the portal.

containerServlet -

activate

void activate(org.apache.jetspeed.factory.PortletFactory portletFactory,
              org.apache.pluto.om.portlet.PortletDefinition portletDefinition,
              javax.servlet.ServletConfig servletConfig,
              String property)

Activating an invoker makes it ready to invoke portlets. If an invoker's state is not activated, it can not invoke. This second signature allows for activating with an extra property.

Parameters:

portletFactory - The factory to get access to the portlet being invoked.

portletDefinition - The portlet's definition that is being invoked.

servletConfig - The servlet configuration of the portal.

property - Implementation specific property

containerServlet -

passivate

void passivate()

Passivates an invoker, freeing it back to the invoker pool. If an invoker's state is passivated, it cannot be used to invoke portlets.

isActivated

boolean isActivated()

Returns true if the state of this invoke is 'activated', and false if it is 'passivated'.

Returns:

True if the current state of the invoker is 'activated' otherwise false.