org.alfresco.web.app.portlet

Class AlfrescoFacesPortlet

java.lang.Object

javax.portlet.GenericPortlet

org.apache.myfaces.portlet.MyFacesGenericPortlet

org.alfresco.web.app.portlet.AlfrescoFacesPortlet

All Implemented Interfaces:

javax.portlet.EventPortlet, javax.portlet.Portlet, javax.portlet.PortletConfig, javax.portlet.ResourceServingPortlet

public class AlfrescoFacesPortlet
extends org.apache.myfaces.portlet.MyFacesGenericPortlet

Class to extend the MyFacesGenericPortlet to provide behaviour specific to Alfresco web client. Handles upload of multi-part forms through a JSR-168 Portlet, generic error handling and session login authentication.

Author:

Gavin Cornwell, Kevin Roast

Field Summary

Fields inherited from class org.apache.myfaces.portlet.MyFacesGenericPortlet

CURRENT_FACES_CONTEXT, DEFAULT_VIEW, DEFAULT_VIEW_SELECTOR, defaultView, defaultViewSelector, FACES_INIT_DONE, facesContextFactory, lifecycle, portletContext, REDEPLOY_FLAG, SAVED_REQUEST_ATTRIBUTES, VIEW_ID

Constructor Summary

Constructors

Constructor and Description
AlfrescoFacesPortlet()

Method Summary

Modifier and Type	Method and Description
protected void	facesRender(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
static String	getActionURL(ServletRequest request) Creates an action url from the given request.
static ErrorBean	getErrorBean(ServletRequest request) Gets the error bean from a request
static FacesContext	getFacesContext(ServletRequest request) Initializes a new faces context using the portlet objects from a 'wrapped' servlet request.
static Object	getPortletSessionAttribute(FacesContext context, String attributeName, boolean shared) Gets a session attribute.
static String	getRenderURL(ServletRequest request, Map<String,String[]> parameters) Creates a render URL from the given request and parameters
static String	getResourceURL(FacesContext context, String path) Creates a resource URL from the given faces context.
static String	onLogOut(Object req)
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response) Called by the portlet container to allow the portlet to process an action request.
void	serveResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response)
protected void	setDefaultViewSelector()
static void	setPortletSessionAttribute(FacesContext context, String attributeName, Object value, boolean shared) Sets a session attribute.

Methods inherited from class org.apache.myfaces.portlet.MyFacesGenericPortlet

destroy, doEdit, doHelp, doView, facesContext, getLifecycleId, handleExceptionFromLifecycle, init, initMyFaces, logException, makeExternalContext, nonFacesRequest, nonFacesRequest, renderCleanup, restoreRequestAttributes, saveRequestAttributes, selectDefaultView, sessionInvalidated, sessionTimedOut, setContentType, setDefaultView, setPortletRequestFlag

Methods inherited from class javax.portlet.GenericPortlet

doDispatch, doHeaders, getContainerRuntimeOptions, getDefaultNamespace, getInitParameter, getInitParameterNames, getNextPossiblePortletModes, getPortletConfig, getPortletContext, getPortletName, getProcessingEventQNames, getPublicRenderParameterNames, getPublishingEventQNames, getResourceBundle, getSupportedLocales, getTitle, init, processEvent, render

Methods inherited from class java.lang.Object

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

Constructor Detail

AlfrescoFacesPortlet

public AlfrescoFacesPortlet()

Method Detail

processAction

public void processAction(javax.portlet.ActionRequest request,
                          javax.portlet.ActionResponse response)
                   throws javax.portlet.PortletException,
                          IOException

Called by the portlet container to allow the portlet to process an action request.

Specified by:

processAction in interface javax.portlet.Portlet

Overrides:

processAction in class org.apache.myfaces.portlet.MyFacesGenericPortlet

Throws:

javax.portlet.PortletException

IOException

serveResource

public void serveResource(javax.portlet.ResourceRequest request,
                          javax.portlet.ResourceResponse response)
                   throws javax.portlet.PortletException,
                          IOException

Specified by:

serveResource in interface javax.portlet.ResourceServingPortlet

Overrides:

serveResource in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

facesRender

protected void facesRender(javax.portlet.RenderRequest request,
                           javax.portlet.RenderResponse response)
                    throws javax.portlet.PortletException,
                           IOException

Overrides:

facesRender in class org.apache.myfaces.portlet.MyFacesGenericPortlet

Throws:

javax.portlet.PortletException

IOException

See Also:

MyFacesGenericPortlet.facesRender(javax.portlet.RenderRequest, javax.portlet.RenderResponse)

getErrorBean

public static ErrorBean getErrorBean(ServletRequest request)

Gets the error bean from a request

Parameters:

request - the request

Returns:

the error bean

getRenderURL

public static String getRenderURL(ServletRequest request,
                                  Map<String,String[]> parameters)

Creates a render URL from the given request and parameters

Parameters:

request - the request

parameters - the parameters

Returns:

the render url

getActionURL

public static String getActionURL(ServletRequest request)

Creates an action url from the given request.

Parameters:

request - the request

Returns:

the action url

getResourceURL

public static String getResourceURL(FacesContext context,
                                    String path)

Creates a resource URL from the given faces context.

Parameters:

context - the faces context

Returns:

the resource URL

getPortletSessionAttribute

public static Object getPortletSessionAttribute(FacesContext context,
                                                String attributeName,
                                                boolean shared)

Gets a session attribute.

Parameters:

context - the faces context

attributeName - the attribute name

shared - get the attribute from shared (application) scope?

Returns:

the portlet session attribute

setPortletSessionAttribute

public static void setPortletSessionAttribute(FacesContext context,
                                              String attributeName,
                                              Object value,
                                              boolean shared)

Sets a session attribute.

Parameters:

context - the faces context

attributeName - the attribute name

value - the value

shared - set the attribute with shared (application) scope?

getFacesContext

public static FacesContext getFacesContext(ServletRequest request)

Initializes a new faces context using the portlet objects from a 'wrapped' servlet request.

Parameters:

request - the servlet request

Returns:

the faces context

onLogOut

public static String onLogOut(Object req)

setDefaultViewSelector

protected void setDefaultViewSelector()
                               throws javax.portlet.UnavailableException

Overrides:

setDefaultViewSelector in class org.apache.myfaces.portlet.MyFacesGenericPortlet

Throws:

javax.portlet.UnavailableException

See Also:

MyFacesGenericPortlet.setDefaultViewSelector()