public interface PortletContainer
PortletContainer
interface is the entrance point of the portlet
container. This singleton is normally called by the aggregation in a specific
order, meaning that each method of this singleton has to be called in a
defined way.The base functionality of the portlet container can be enhanced or even modified by PortletContainerServices.
The methods of this class have to be called in the following order:
init(java.lang.String, javax.servlet.ServletConfig, org.apache.pluto.services.PortletContainerEnvironment, java.util.Properties)
shutdown()
renderPortlet(org.apache.pluto.om.window.PortletWindow, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
(for each portlet)processPortletAction(org.apache.pluto.om.window.PortletWindow, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
(for portlet receiving the action request)Modifier and Type | Method and Description |
---|---|
void |
init(java.lang.String uniqueContainerName,
javax.servlet.ServletConfig servletConfig,
PortletContainerEnvironment environment,
java.util.Properties properties)
Initializes the portlet container.
|
boolean |
isInitialized()
Returns whether the container is already initialized or not.
|
void |
portletLoad(PortletWindow portletWindow,
javax.servlet.http.HttpServletRequest servletRequest,
javax.servlet.http.HttpServletResponse servletResponse)
Indicates that the portlet must be initialized
|
void |
processPortletAction(PortletWindow portletWindow,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Indicates that a portlet action occured in the current request and
calls the processAction method of this portlet.
|
void |
renderPortlet(PortletWindow portletWindow,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Calls the render method of the given portlet window.
|
void |
shutdown()
Shuts down the portlet container.
|
void init(java.lang.String uniqueContainerName, javax.servlet.ServletConfig servletConfig, PortletContainerEnvironment environment, java.util.Properties properties) throws PortletContainerException
uniqueContainerName
- container name that must be unqiue across all containers defined within this JVM. This name must be identical across JVMs.servletConfig
- the servlet configurationenvironment
- the portlet container environment including all servicesproperties
- the portlet container specific properties may vary from container to containerPortletContainerException
- if an error occurs while initializing the containervoid shutdown() throws PortletContainerException
PortletContainerException
- if an error occurs while shutting down the containervoid renderPortlet(PortletWindow portletWindow, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.portlet.PortletException, java.io.IOException, PortletContainerException
portletWindow
- the portlet Windowrequest
- the servlet requestresponse
- the servlet responsejavax.portlet.PortletException
- if one portlet has trouble fulfilling the requestjava.io.IOException
- if the streaming causes an I/O problemPortletContainerException
- if the portlet container implementation has trouble fulfilling the requestvoid processPortletAction(PortletWindow portletWindow, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.portlet.PortletException, java.io.IOException, PortletContainerException
portletWindow
- the portlet Windowrequest
- the servlet requestresponse
- the servlet responsejavax.portlet.PortletException
- if one portlet has trouble fulfilling the requestPortletContainerException
- if the portlet container implementation has trouble fulfilling the requestjava.io.IOException
void portletLoad(PortletWindow portletWindow, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse) throws javax.portlet.PortletException, PortletContainerException
portletWindow
- the portlet WindowservletRequest
- the servlet requestservletResponse
- the servlet responsejavax.portlet.PortletException
- if one portlet has trouble fulfilling the requestPortletContainerException
- if the portlet container implementation has trouble fulfilling the requestboolean isInitialized()
true
if the container is initializedCopyright © 2003-2013 . All Rights Reserved.