javax.portlet.faces

Class GenericFacesPortlet

java.lang.Object

javax.portlet.GenericPortlet

javax.portlet.faces.GenericFacesPortlet

All Implemented Interfaces:

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

public class GenericFacesPortlet
extends javax.portlet.GenericPortlet

The GenericFacesPortlet is provided to simplify development of a portlet that in whole or part relies on the Faces bridge to process requests. If all requests are to be handled by the bridge, GenericFacesPortlet is a turnkey implementation. Developers do not need to subclass it. However, if there are some situations where the portlet doesn't require bridge services then GenericFacesPortlet can be subclassed and overriden.

Since GenericFacesPortlet subclasses GenericPortlet care is taken to all subclasses to override naturally. For example, though doDispatch() is overriden, requests are only dispatched to the bridge from here if the PortletMode isn't VIEW, EDIT, or HELP.

The GenericFacesPortlet recognizes the following portlet initialization parameters:

• javax.portlet.faces.defaultViewId.[mode]: specifies on a per mode basis the default viewId the Bridge executes when not already encoded in the incoming request. A value must be defined for each PortletMode the Bridge is expected to process.
• javax.portlet.faces.excludedRequestAttributes: specifies on a per portlet basis the set of request attributes the bridge is to exclude from its request scope. The value of this parameter is a comma delimited list of either fully qualified attribute names or a partial attribute name of the form packageName.*. In this later case all attributes exactly prefixed by packageName are excluded, non recursive.
• javax.portlet.faces.preserveActionParams: specifies on a per portlet basis whether the bridge should preserve parameters received in an action request and restore them for use during subsequent renders.
• javax.portlet.faces.defaultContentType: specifies on a per mode basis the content type the bridge should set for all render requests it processes.
• javax.portlet.faces.defaultCharacterSetEncoding: specifies on a per mode basis the default character set encoding the bridge should set for all render requests it processes

The GenericFacesPortlet recognizes the following application (PortletContext) initialization parameters:

• javax.portlet.faces.BridgeImplClass: specifies the Bridgeimplementation class used by this portlet. Typically this initialization parameter isn't set as the GenericFacesPortlet defaults to finding the class name from the bridge configuration. However if more then one bridge is configured in the environment such per application configuration is necessary to force a specific bridge to be used.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BRIDGE_AUTO_DISPATCH_EVENTS Portlet init parameter containing the setting for whether the GenericFacesPortlet overrides event processing by dispatching all events to the bridge or delegates all event processing to the GenericPortlet.
static String	BRIDGE_CLASS Application (PortletContext) init parameter that names the bridge class used by this application.
static String	BRIDGE_SERVICE_CLASSPATH Location of the services descriptor file in a brige installation that defines the class name of the bridge implementation.
static String	DEFAULT_CHARACTERSET_ENCODING Portlet init parameter that defines the render response CharacterSetEncoding the bridge sets prior to rendering.
static String	DEFAULT_CONTENT_TYPE Portlet init parameter that defines the render response ContentType the bridge sets prior to rendering.
static String	DEFAULT_VIEWID Portlet init parameter that defines the default ViewId that should be used when the request doesn't otherwise convery the target.

Constructor Summary

Constructors

Constructor and Description
GenericFacesPortlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
protected void	doDispatch(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response) If mode is VIEW, EDIT, or HELP -- defer to the doView, doEdit, doHelp so subclasses can override.
protected void	doEdit(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected void	doHelp(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
protected void	doView(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response)
String	getBridgeClassName() JSR 301 API method
BridgeEventHandler	getBridgeEventHandler()
BridgePublicRenderParameterHandler	getBridgePublicRenderParameterHandler()
String	getDefaultRenderKitId() Returns a String defining the default render kit id the bridge should ensure for this portlet.
Map<String,String>	getDefaultViewIdMap() JSR 301 API method
List<String>	getExcludedRequestAttributes() 4.2.7 getExcludedRequestAttributes() As a portlet lifecycle allows multiple (re)renders to occur following an action, the bridge manages an extended notion of a request scope to ensure that such rerenders produces identical results.
Bridge	getFacesBridge() Get current Bridge instance.
Bridge	getFacesBridge(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response) Returns an initialized bridge instance adequately prepared so the caller can call doFacesRequest directly without further initialization.
String	getResponseCharacterSetEncoding(javax.portlet.PortletRequest request) Deprecated. -- no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.
String	getResponseContentType(javax.portlet.PortletRequest request) Deprecated. -- no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.
void	init(javax.portlet.PortletConfig config) Initialize generic faces portlet from portlet.xml
Boolean	isAutoDispatchEvents() Returns the value of the portlet initialization parameter javax.portlet.faces.autoDispatchEvents if non-null or true, otherwise.
Boolean	isPreserveActionParameters() 4.2.8 getPreserveActionParameters() By default the bridge doesn't preserve action parameters into subsequent renders.
void	processAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response)
void	processEvent(javax.portlet.EventRequest request, javax.portlet.EventResponse response)
void	serveResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response)

Methods inherited from class javax.portlet.GenericPortlet

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

Methods inherited from class java.lang.Object

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

Field Detail

BRIDGE_CLASS

public static final String BRIDGE_CLASS

Application (PortletContext) init parameter that names the bridge class used by this application. Typically not used unless more then 1 bridge is configured in an environment as its more usual to rely on the self detection.

See Also:

Constant Field Values

DEFAULT_VIEWID

public static final String DEFAULT_VIEWID

Portlet init parameter that defines the default ViewId that should be used when the request doesn't otherwise convery the target. There must be one initialization parameter for each supported mode. Each parameter is named DEFAULT_VIEWID.mode, where mode is the name of the corresponding PortletMode

See Also:

Constant Field Values

DEFAULT_CONTENT_TYPE

public static final String DEFAULT_CONTENT_TYPE

Portlet init parameter that defines the render response ContentType the bridge sets prior to rendering. If not set the bridge uses the request's preferred content type.

See Also:

Constant Field Values

DEFAULT_CHARACTERSET_ENCODING

public static final String DEFAULT_CHARACTERSET_ENCODING

Portlet init parameter that defines the render response CharacterSetEncoding the bridge sets prior to rendering. Typcially only set when the jsp outputs an encoding other then the portlet container's and the portlet container supports response encoding transformation.

See Also:

Constant Field Values

BRIDGE_AUTO_DISPATCH_EVENTS

public static final String BRIDGE_AUTO_DISPATCH_EVENTS

Portlet init parameter containing the setting for whether the GenericFacesPortlet overrides event processing by dispatching all events to the bridge or delegates all event processing to the GenericPortlet. Default is true.

See Also:

Constant Field Values

BRIDGE_SERVICE_CLASSPATH

public static final String BRIDGE_SERVICE_CLASSPATH

Location of the services descriptor file in a brige installation that defines the class name of the bridge implementation.

See Also:

Constant Field Values

Constructor Detail

GenericFacesPortlet

public GenericFacesPortlet()

Method Detail

init

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

Initialize generic faces portlet from portlet.xml

Specified by:

init in interface javax.portlet.Portlet

Overrides:

init in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

getExcludedRequestAttributes

public List<String> getExcludedRequestAttributes()

4.2.7 getExcludedRequestAttributes() As a portlet lifecycle allows multiple (re)renders to occur following an action, the bridge manages an extended notion of a request scope to ensure that such rerenders produces identical results. Specifically, portlet scoped request attributes are saved/restored by the bridge across such rerenders [5.1.2]. However, sometimes a portlet request scoped attribute truly must be removed when the request scope ends. The bridge uses multiple mechanisms for determining which attributes are marked for exclusion from its managed scope. The portlet can directly instruct the bridge to exclude attributes on a per portlet basis by setting a PorletContext attribute [3.2]. This attribute's value is a List containing the excluded attribute names. The GenericFacesPortlet sets this attribute based on the result of calling getExcludedRequestAttributes() in its init() method. The default (GenericFacesPortlet) implementation for getExcludedRequestAttributes() returns a List constructed by parsing the comma delimited String value from the corresponding portlet initialization parameter, javax.portlet.faces.excludedRequestAttributes. If this initialization parameter isn't present null is returned which causes the GenericFacesPortlet to not set the corresponding PortletContext attribute.

Returns:

isPreserveActionParameters

public Boolean isPreserveActionParameters()

4.2.8 getPreserveActionParameters() By default the bridge doesn't preserve action parameters into subsequent renders. This can be overridden on a per portlet basis by passing a value of true in the appropriate PortletContext attribute [3.2]. To determine the setting for this attributes for this particular portlet, the GenericFacesPortlet calls getPreserveActionParameters() in its init() method. The default (GenericFacesPortlet) implementation returns the Boolean value corresponding to the String value represented in the portlet initialization parameter, javax.portlet.faces.preserveActionParams. If this initialization parameter doesn't exist, Boolean.FALSE is returned.

Returns:

preserve or not action attributes.

getDefaultRenderKitId

public String getDefaultRenderKitId()

Returns a String defining the default render kit id the bridge should ensure for this portlet. If non-null, this value is used to override any default render kit id set on an app wide basis in the faces-config.xml. This default implementation reads the values from the portlet init_param javax.portlet.faces.defaultRenderKitId. If not present, null is returned.

Returns:

a boolean indicating whether or not the bridge should preserve all the action parameters in the subsequent renders that occur in the same scope.

isAutoDispatchEvents

public Boolean isAutoDispatchEvents()

Returns the value of the portlet initialization parameter javax.portlet.faces.autoDispatchEvents if non-null or true, otherwise.

Returns:

boolean indicating whether to auto-dispatch all events to the bridge or not.

getBridgeEventHandler

public BridgeEventHandler getBridgeEventHandler()

Returns:

an instance of BridgeEventHandler or null if there is none.

getBridgePublicRenderParameterHandler

public BridgePublicRenderParameterHandler getBridgePublicRenderParameterHandler()

Returns:

an instance of BridgeRenderParameterHandler or null if there is none.

getBridgeClassName

public String getBridgeClassName()
                          throws javax.portlet.PortletException

JSR 301 API method

Returns:

Throws:

javax.portlet.PortletException

getDefaultViewIdMap

public Map<String,String> getDefaultViewIdMap()

JSR 301 API method

Returns:

getFacesBridge

public Bridge getFacesBridge(javax.portlet.PortletRequest request,
                    javax.portlet.PortletResponse response)
                      throws javax.portlet.PortletException

Returns an initialized bridge instance adequately prepared so the caller can call doFacesRequest directly without further initialization.

Returns:

instance of the bridge.

Throws:

javax.portlet.PortletException - exception acquiring or initializing the bridge.

getFacesBridge

public Bridge getFacesBridge()
                      throws javax.portlet.PortletException

Get current Bridge instance. Bridge will be created and initialized on first request only.

Returns:

the facesPortletBridge

Throws:

javax.portlet.PortletException

destroy

public void destroy()

Specified by:

destroy in interface javax.portlet.Portlet

Overrides:

destroy in class javax.portlet.GenericPortlet

doDispatch

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

If mode is VIEW, EDIT, or HELP -- defer to the doView, doEdit, doHelp so subclasses can override. Otherwise handle mode here if there is a defaultViewId mapping for it.

Overrides:

doDispatch in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

doEdit

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

Overrides:

doEdit in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

doHelp

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

Overrides:

doHelp in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

doView

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

Overrides:

doView in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

processAction

public void processAction(javax.portlet.ActionRequest request,
                 javax.portlet.ActionResponse response)
                   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

See Also:

GenericPortlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)

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

processEvent

public void processEvent(javax.portlet.EventRequest request,
                javax.portlet.EventResponse response)
                  throws javax.portlet.PortletException,
                         IOException

Specified by:

processEvent in interface javax.portlet.EventPortlet

Overrides:

processEvent in class javax.portlet.GenericPortlet

Throws:

javax.portlet.PortletException

IOException

getResponseCharacterSetEncoding

@Deprecated
public String getResponseCharacterSetEncoding(javax.portlet.PortletRequest request)

Deprecated. -- no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.

Returns:

null.

getResponseContentType

@Deprecated
public String getResponseContentType(javax.portlet.PortletRequest request)

Deprecated. -- no longer used or called by the GenericFacesPortlet but retained in case a subclass has called it.

Returns:

request.getResponseContentType().