com.liferay.faces.bridge.event

Class EventPayloadWrapper

java.lang.Object

com.liferay.faces.bridge.event.EventPayloadWrapper

All Implemented Interfaces:

java.io.Serializable, javax.faces.FacesWrapper<java.io.Serializable>

@ProviderType
public class EventPayloadWrapper
extends java.lang.Object
implements javax.faces.FacesWrapper<java.io.Serializable>, java.io.Serializable

The purpose of this class is to provide support a vendor-specific feature of Liferay Portal that provides the ability to broadcast Portlet 2.0 Events to portlets that exist on a different portal page. For more information, refer to the "portlet.event.distribution" key inside of the Liferay Portal portal.properties file.

This class provides the ability to wrap a Serializable event payload that is intended to be sent via StateAwareResponse.setEvent(String, Serializable) or StateAwareResponse.setEvent(javax.xml.namespace.QName, Serializable). It also provides the ability for the recipient of the event to determine whether or not a redirect is taking place.

Author:

Neil Griffin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EventPayloadWrapper(java.io.Serializable payload, boolean redirect) Constructs a new EventPayloadWrapper instance.

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	getWrapped()
boolean	isRedirect()

Methods inherited from class java.lang.Object

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

Constructor Detail

EventPayloadWrapper

public EventPayloadWrapper(java.io.Serializable payload,
                           boolean redirect)

Constructs a new EventPayloadWrapper instance.

Parameters:

payload - The Serializable payload that is to be wrapped.

redirect - The flag indicating whether or not a redirect is taking place.

Method Detail

getWrapped

public java.io.Serializable getWrapped()

Specified by:

getWrapped in interface javax.faces.FacesWrapper<java.io.Serializable>

isRedirect

public boolean isRedirect()