org.apache.pluto.container.driver

Interface PortletContextService

public interface PortletContextService

Interface defining the services used by both the Pluto Portal Driver and the Pluto PortletServlet for registration and access to the PortletContexts and ClassLoader of registered Portlet Applications.

Since:

2.0

Version:

$Id$

Method Summary

Modifier and Type	Method and Description
ClassLoader	getClassLoader(String applicationName) Retrieve the ClassLoader of the specified portlet application
DriverPortletConfig	getPortletConfig(String applicationName, String portletName) Retrieve the portlet configuration for the specified portlet
DriverPortletContext	getPortletContext(org.apache.pluto.container.PortletWindow portletWindow) Retrieve the InternalPortletContext for the specified portlet window
DriverPortletContext	getPortletContext(String applicationName) Retrieve the InternalPortletContext for the specified portlet application name
Iterator<DriverPortletContext>	getPortletContexts() Retrieve all registered applications.
String	register(javax.servlet.ServletConfig config) Register a portlet application
void	unregister(DriverPortletContext context) Unregister a portlet application

Method Detail

getPortletContexts

Iterator<DriverPortletContext> getPortletContexts()

Retrieve all registered applications. This list will only contain those applications which have been registered with the container. Others may or may not be available within the servers.

Returns:

iterator of all application descriptors.

getPortletContext

DriverPortletContext getPortletContext(String applicationName)
                                throws org.apache.pluto.container.PortletContainerException

Retrieve the InternalPortletContext for the specified portlet application name

Parameters:

applicationName - portlet application name

Returns:

portlet context or null if not registered

Throws:

org.apache.pluto.container.PortletContainerException

getPortletContext

DriverPortletContext getPortletContext(org.apache.pluto.container.PortletWindow portletWindow)
                                throws org.apache.pluto.container.PortletContainerException

Retrieve the InternalPortletContext for the specified portlet window

Parameters:

portletWindow - portlet window

Returns:

portlet context or null if not registered

Throws:

org.apache.pluto.container.PortletContainerException

getPortletConfig

DriverPortletConfig getPortletConfig(String applicationName,
                                     String portletName)
                              throws org.apache.pluto.container.PortletContainerException

Retrieve the portlet configuration for the specified portlet

Parameters:

applicationName - portlet application name

portletName - portlet name

Returns:

portletconfig

Throws:

org.apache.pluto.container.PortletContainerException - if portlet or application unknown

getClassLoader

ClassLoader getClassLoader(String applicationName)
                    throws org.apache.pluto.container.PortletContainerException

Retrieve the ClassLoader of the specified portlet application

Parameters:

applicationName - portlet application name

Returns:

classLoader

Throws:

org.apache.pluto.container.PortletContainerException

register

String register(javax.servlet.ServletConfig config)
         throws org.apache.pluto.container.PortletContainerException

Register a portlet application

Parameters:

config -

Returns:

Throws:

org.apache.pluto.container.PortletContainerException

unregister

void unregister(DriverPortletContext context)

Unregister a portlet application

Parameters:

context -