public class EventPayloadWrapper extends Object implements javax.faces.FacesWrapper<Serializable>, 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.
Constructor and Description |
---|
EventPayloadWrapper(Serializable payload,
boolean redirect)
Constructs a new
EventPayloadWrapper instance. |
Modifier and Type | Method and Description |
---|---|
Serializable |
getWrapped() |
boolean |
isRedirect() |
public EventPayloadWrapper(Serializable payload, boolean redirect)
EventPayloadWrapper
instance.payload
- The Serializable
payload that is to be wrapped.redirect
- The flag indicating whether or not a redirect is taking place.public Serializable getWrapped()
getWrapped
in interface javax.faces.FacesWrapper<Serializable>
public boolean isRedirect()
Copyright © 2018 Liferay, Inc. All rights reserved.