org.apache.cocoon.portlet
Class ManagedCocoonPortlet

java.lang.Object
  javax.portlet.GenericPortlet
      org.apache.cocoon.portlet.ManagedCocoonPortlet

All Implemented Interfaces:

javax.portlet.Portlet, javax.portlet.PortletConfig

public class ManagedCocoonPortlet
extends javax.portlet.GenericPortlet

This is the entry point for Cocoon execution as an JSR-168 Portlet.

This implementation of the Portlet interface requires that someone will first create and initialize an instance of the Cocoon object, and this Portlet will use this instance to process requests.

Version:

CVS $Id: ManagedCocoonPortlet.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

protected int	defaultSessionScope Default scope for the session attributes, either PortletSession.PORTLET_SCOPE or PortletSession.APPLICATION_SCOPE.
protected PortletContext	envPortletContext
protected Exception	exception Holds exception happened during initialization (if any)
protected boolean	hiddenShowTime If true, processing time will be added as an HTML comment
protected javax.portlet.PortletContext	portletContext
protected String	portletContextPath This is the path to the portlet context (or the result of calling getRealPath('/') on the PortletContext.
protected String	portletContextURL This is the url to the portlet context directory
protected static String	PROCESSED_BY
protected RequestFactory	requestFactory The RequestFactory is responsible for wrapping multipart-encoded forms and for handing the file payload of incoming requests
protected String	servletPath Value to be used as servletPath in the request.
protected boolean	showTime Allow adding processing time to the response
protected boolean	storeSessionPath Store pathInfo in session

Constructor Summary

ManagedCocoonPortlet()

Method Summary

protected Environment	getEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.ActionRequest req, javax.portlet.ActionResponse res) Create the environment for the request
protected Environment	getEnvironment(String servletPath, String pathInfo, String uri, javax.portlet.RenderRequest req, javax.portlet.RenderResponse res) Create the environment for the request
String	getInitParameter(String name) Get an initialisation parameter.
protected String	getInitParameter(String name, String defaultValue) Convenience method to access portlet parameters
protected boolean	getInitParameterAsBoolean(String name, boolean defaultValue) Convenience method to access boolean portlet parameters
protected int	getInitParameterAsInteger(String name, int defaultValue)
protected Logger	getLogger()
void	init(javax.portlet.PortletConfig conf) Initialize this CocoonPortlet instance.
protected void	initLogger()
protected void	manageException(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res, Environment env, String uri, String title, String message, String description, Exception e)
protected void	manageException(javax.portlet.RenderRequest req, javax.portlet.RenderResponse res, Environment env, String uri, String title, String message, String description, Exception e)
void	processAction(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res)
void	render(javax.portlet.RenderRequest req, javax.portlet.RenderResponse res) Process the specified RenderRequest producing output on the specified RenderResponse.

Methods inherited from class javax.portlet.GenericPortlet

destroy, doDispatch, doEdit, doHelp, doView, getInitParameterNames, getPortletConfig, getPortletContext, getPortletName, getResourceBundle, getTitle, init

Methods inherited from class java.lang.Object

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

Field Detail

PROCESSED_BY

protected static final String PROCESSED_BY

exception

protected Exception exception

Holds exception happened during initialization (if any)

showTime

protected boolean showTime

Allow adding processing time to the response

hiddenShowTime

protected boolean hiddenShowTime

If true, processing time will be added as an HTML comment

portletContext

protected javax.portlet.PortletContext portletContext

envPortletContext

protected PortletContext envPortletContext

portletContextPath

protected String portletContextPath

This is the path to the portlet context (or the result of calling getRealPath('/') on the PortletContext. Note, that this can be null.

portletContextURL

protected String portletContextURL

This is the url to the portlet context directory

requestFactory

protected RequestFactory requestFactory

The RequestFactory is responsible for wrapping multipart-encoded forms and for handing the file payload of incoming requests

servletPath

protected String servletPath

Value to be used as servletPath in the request. Provided via configuration parameter, if missing, defaults to the '/portlets/' + portletName.

defaultSessionScope

protected int defaultSessionScope

Default scope for the session attributes, either PortletSession.PORTLET_SCOPE or PortletSession.APPLICATION_SCOPE. This corresponds to default-session-scope parameter, with default value portlet.

See Also:

PortletSession

storeSessionPath

protected boolean storeSessionPath

Store pathInfo in session

Constructor Detail

ManagedCocoonPortlet

public ManagedCocoonPortlet()

Method Detail

init

public void init(javax.portlet.PortletConfig conf)
          throws javax.portlet.PortletException

Initialize this CocoonPortlet instance.

Uses the following parameters: portlet-logger enable-uploads autosave-uploads overwrite-uploads upload-max-size show-time container-encoding form-encoding manage-exceptions servlet-path

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class javax.portlet.GenericPortlet

Parameters:

conf - The PortletConfig object from the portlet container.

Throws:

javax.portlet.PortletException

processAction

public void processAction(javax.portlet.ActionRequest req,
                          javax.portlet.ActionResponse res)
                   throws javax.portlet.PortletException,
                          IOException

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

render

public void render(javax.portlet.RenderRequest req,
                   javax.portlet.RenderResponse res)
            throws javax.portlet.PortletException,
                   IOException

Process the specified RenderRequest producing output on the specified RenderResponse.

Specified by:

render in interface javax.portlet.Portlet

Overrides:

render in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

manageException

protected void manageException(javax.portlet.ActionRequest req,
                               javax.portlet.ActionResponse res,
                               Environment env,
                               String uri,
                               String title,
                               String message,
                               String description,
                               Exception e)
                        throws javax.portlet.PortletException

Throws:

javax.portlet.PortletException

manageException

protected void manageException(javax.portlet.RenderRequest req,
                               javax.portlet.RenderResponse res,
                               Environment env,
                               String uri,
                               String title,
                               String message,
                               String description,
                               Exception e)
                        throws IOException,
                               javax.portlet.PortletException

Throws:

IOException

javax.portlet.PortletException

getEnvironment

protected Environment getEnvironment(String servletPath,
                                     String pathInfo,
                                     String uri,
                                     javax.portlet.ActionRequest req,
                                     javax.portlet.ActionResponse res)
                              throws Exception

Create the environment for the request

Throws:

Exception

getEnvironment

protected Environment getEnvironment(String servletPath,
                                     String pathInfo,
                                     String uri,
                                     javax.portlet.RenderRequest req,
                                     javax.portlet.RenderResponse res)
                              throws Exception

Create the environment for the request

Throws:

Exception

getInitParameter

public String getInitParameter(String name)

Get an initialisation parameter. The value is trimmed, and null is returned if the trimmed value is empty.

Specified by:

getInitParameter in interface javax.portlet.PortletConfig

Overrides:

getInitParameter in class javax.portlet.GenericPortlet

getInitParameter

protected String getInitParameter(String name,
                                  String defaultValue)

Convenience method to access portlet parameters

getInitParameterAsBoolean

protected boolean getInitParameterAsBoolean(String name,
                                            boolean defaultValue)

Convenience method to access boolean portlet parameters

getInitParameterAsInteger

protected int getInitParameterAsInteger(String name,
                                        int defaultValue)

initLogger

protected void initLogger()

getLogger

protected Logger getLogger()