com.liferay.faces.bridge
Class BridgeEventHandlerWrapper

java.lang.Object
  com.liferay.faces.bridge.BridgeEventHandlerWrapper

All Implemented Interfaces:

javax.faces.FacesWrapper<BridgeEventHandler>, BridgeEventHandler

public abstract class BridgeEventHandlerWrapper
extends Object
implements BridgeEventHandler, javax.faces.FacesWrapper<BridgeEventHandler>

Author:

Neil Griffin

Constructor Summary

BridgeEventHandlerWrapper()

Method Summary

abstract BridgeEventHandler	getWrapped()
EventNavigationResult	handleEvent(javax.faces.context.FacesContext facesContext, javax.portlet.Event event) Called by the bridge when it needs to process a portlet event.

Methods inherited from class java.lang.Object

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

Constructor Detail

BridgeEventHandlerWrapper

public BridgeEventHandlerWrapper()

Method Detail

getWrapped

public abstract BridgeEventHandler getWrapped()

Specified by:

getWrapped in interface javax.faces.FacesWrapper<BridgeEventHandler>

handleEvent

public EventNavigationResult handleEvent(javax.faces.context.FacesContext facesContext,
                                         javax.portlet.Event event)

Description copied from interface: BridgeEventHandler

Called by the bridge when it needs to process a portlet event.

Because portlet events have arbitrary payloads the bridge provides no automated mappings to managed beans. Instead, the bridge calls this method on the BridgeEventHandler instance passed to it (via a portlet context attribute at initialization time. This method is expected to update any models based on the event's payload and then to perform any needed application re-computation to ensure a consistent state. The method is called after the FacesContext has been established and the Lifecycle has restored the view.

A view navigation can be affected by returning a non-null EventNavigationResult. Such an object will contain two String values: a fromAction and an outcome. These correspond to the from action and outcomes in Faces navigation rules. Using this information the bridge affects the navigation by calling the Faces javax.faces.application.NavigationHandler.

Specified by:

handleEvent in interface BridgeEventHandler

Parameters:

facesContext - The current Faces context. A Lifecycle has been acquired and the current view restored.

event - The portlet event. Other portlet information (request/response) is accessed via the ExternalContext.

Returns:

an object containing the fromAction and outcome of any navigation that resulted from this event. If the event doesn't cause a navigation, return null.