Package org.gatein.pc.portlet.impl.jsr168

Class PortletContainerImpl

java.lang.Object

org.gatein.pc.portlet.impl.jsr168.PortletContainerImpl

All Implemented Interfaces:

PortletContainerObject, PortletContainer

public class PortletContainerImpl
extends Object
implements PortletContainerObject

Version:

$Revision: 6365 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field	Description
protected PortletApplicationImpl	application	.
protected String	className	The portlet implementation class name.
protected javax.portlet.PortletConfig	config	The portlet config.
protected org.gatein.common.logging.Logger	log	Logger.
protected javax.portlet.Portlet	portlet	The portlet instance.
protected javax.portlet.PreferencesValidator	preferencesValidator	The preference validator, this is not exposed as runtime meta data as it is only used by the JSR 168 portlet container implementation.
protected LifeCycleStatus	status	Are we started or not.
protected Set	userDataConstraints	User data constraint.
protected org.gatein.common.concurrent.Valve	valve	The invocation valve.

Constructor Summary

Constructors

Constructor	Description
PortletContainerImpl(ContainerPortletInfo info)

Method Summary

Modifier and Type	Method	Description
void	addPortletFilter(PortletFilter filter)	Add a filter.
void	create()	Creates the portlet container.
void	destroy()	Destroys the portlet container.
org.gatein.pc.api.invocation.response.PortletInvocationResponse	dispatch(org.gatein.pc.api.invocation.PortletInvocation invocation)	Invoke the portlet container.
javax.portlet.PortletConfig	getConfig()
PortletContainerContext	getContext()	Returns the context of the portlet container.
String	getId()	Return the portlet container id, unique within the context of the parent application.
ContainerPortletInfo	getInfo()	Returns the runtime meta data of the container.
javax.portlet.Portlet	getPortlet()
PortletApplication	getPortletApplication()	Returns the wired application.
javax.portlet.Portlet	getPortletInstance()	Returns the current instance held by the container.
javax.portlet.PreferencesValidator	getPreferencesValidator()
Set	getUserDataConstraints()
org.gatein.common.concurrent.Valve	getValve()
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.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

log

protected final org.gatein.common.logging.Logger log

Logger.

application

protected PortletApplicationImpl application

.

className

protected String className

The portlet implementation class name.

config

protected javax.portlet.PortletConfig config

The portlet config.

portlet

protected javax.portlet.Portlet portlet

The portlet instance.

valve

protected final org.gatein.common.concurrent.Valve valve

The invocation valve.

status

protected LifeCycleStatus status

Are we started or not.

userDataConstraints

protected Set userDataConstraints

User data constraint.

preferencesValidator

protected javax.portlet.PreferencesValidator preferencesValidator

The preference validator, this is not exposed as runtime meta data as it is only used by the JSR 168 portlet container implementation.

Constructor Detail

PortletContainerImpl

public PortletContainerImpl(ContainerPortletInfo info)

Method Detail

setContext

public void setContext(PortletContainerContext context)

Description copied from interface: PortletContainerObject

Set/unset the portlet container context.

Specified by:

setContext in interface PortletContainerObject

Parameters:

context - the context

getContext

public PortletContainerContext getContext()

Description copied from interface: PortletContainer

Returns the context of the portlet container.

Specified by:

getContext in interface PortletContainer

Returns:

the context

getInfo

public ContainerPortletInfo getInfo()

Description copied from interface: PortletContainer

Returns the runtime meta data of the container.

Specified by:

getInfo in interface PortletContainer

Returns:

the info

getPortletInstance

public javax.portlet.Portlet getPortletInstance()

Description copied from interface: PortletContainerObject

Returns the current instance held by the container.

Specified by:

getPortletInstance in interface PortletContainerObject

Returns:

the instance

getId

public String getId()

Description copied from interface: PortletContainer

Return the portlet container id, unique within the context of the parent application.

Specified by:

getId in interface PortletContainer

Returns:

the id

addPortletFilter

public void addPortletFilter(PortletFilter filter)

Description copied from interface: PortletContainerObject

Add a filter.

Specified by:

addPortletFilter in interface PortletContainerObject

Parameters:

filter - the portlet filter

removePortletFilter

public void removePortletFilter(PortletFilter filter)

Description copied from interface: PortletContainerObject

Remove a filter.

Specified by:

removePortletFilter in interface PortletContainerObject

Parameters:

filter - the portlet filter

create

public void create()
            throws Exception

Description copied from interface: PortletContainerObject

Creates the portlet container.

Specified by:

create in interface PortletContainerObject

Throws:

Exception - any exception preventing the creation

start

public void start()
           throws Exception

Description copied from interface: PortletContainerObject

Starts the portlet container.

Specified by:

start in interface PortletContainerObject

Throws:

Exception - any exception preventing the start

stop

public void stop()

Description copied from interface: PortletContainerObject

Stops the portlet container.

Specified by:

stop in interface PortletContainerObject

destroy

public void destroy()

Description copied from interface: PortletContainerObject

Destroys the portlet container.

Specified by:

destroy in interface PortletContainerObject

getConfig

public javax.portlet.PortletConfig getConfig()

getPortlet

public javax.portlet.Portlet getPortlet()

getPortletApplication

public PortletApplication getPortletApplication()

Description copied from interface: PortletContainer

Returns the wired application.

Specified by:

getPortletApplication in interface PortletContainer

Returns:

the application

setPortletApplication

public void setPortletApplication(PortletApplication application)

Description copied from interface: PortletContainerObject

Set/unset the application.

Specified by:

setPortletApplication in interface PortletContainerObject

Parameters:

application - the related application

getValve

public org.gatein.common.concurrent.Valve getValve()

getUserDataConstraints

public Set getUserDataConstraints()

getPreferencesValidator

public javax.portlet.PreferencesValidator getPreferencesValidator()

toString

public String toString()

Overrides:

toString in class Object

dispatch

public org.gatein.pc.api.invocation.response.PortletInvocationResponse dispatch(org.gatein.pc.api.invocation.PortletInvocation invocation)
                                                                         throws org.gatein.pc.api.PortletInvokerException,
                                                                                org.gatein.pc.api.invocation.InvocationException

Description copied from interface: PortletContainer

Invoke the portlet container.

Specified by:

dispatch in interface PortletContainer

Parameters:

invocation - the portlet invocation

Returns:

the portlet invocation response

Throws:

org.gatein.pc.api.PortletInvokerException - a portlet invoker exception

org.gatein.pc.api.invocation.InvocationException - an invocation exception