org.gatein.pc.portlet.container.object

Interface PortletContainerObject

All Superinterfaces:

PortletContainer

All Known Implementing Classes:

PortletContainerImpl

public interface PortletContainerObject
extends PortletContainer

Contains life cycle and wiring details for the kernel environment.

Version:

$Revision: 630 $

Author:

Julien Viet

Method Summary

Modifier and Type	Method and Description
void	addPortletFilter(PortletFilter filter) Add a filter.
void	create() Creates the portlet container.
void	destroy() Destroys the portlet container.
javax.portlet.Portlet	getPortletInstance() Returns the current instance held by the container.
void	removePortletFilter(PortletFilter filter) Remove a filter.
void	setContext(PortletContainerContext context) Set/unset the portlet container context.
void	setPortletApplication(PortletApplication application) Set/unset the application.
void	start() Starts the portlet container.
void	stop() Stops the portlet container.

Methods inherited from interface org.gatein.pc.portlet.container.PortletContainer

dispatch, getContext, getId, getInfo, getPortletApplication

Method Detail

setPortletApplication

void setPortletApplication(PortletApplication application)

Set/unset the application.

Parameters:

application - the related application

setContext

void setContext(PortletContainerContext context)

Set/unset the portlet container context.

Parameters:

context - the context

addPortletFilter

void addPortletFilter(PortletFilter filter)

Add a filter.

Parameters:

filter - the portlet filter

removePortletFilter

void removePortletFilter(PortletFilter filter)

Remove a filter.

Parameters:

filter - the portlet filter

create

void create()
     throws Exception

Creates the portlet container.

Throws:

Exception - any exception preventing the creation

start

void start()
    throws Exception

Starts the portlet container.

Throws:

Exception - any exception preventing the start

stop

void stop()

Stops the portlet container.

destroy

void destroy()

Destroys the portlet container.

getPortletInstance

javax.portlet.Portlet getPortletInstance()

Returns the current instance held by the container.

Returns:

the instance