Top Description Fields Constructors Methods
javax.portlet

public Class PortletAsyncEvent

extends Object
Class Inheritance
Event that gets fired when the asynchronous operation initiated on a ResourceRequest (via a call to ResourceRequest#startAsync or ResourceRequest#startAsync(ResourceRequest, ResouceResponse)) has completed, timed out, or produced an error.
Since
3.0
See Also
PortletAsyncContext, PortletAsyncEvent, ResourceRequest

Field Summary

Modifier and TypeField and Description
pack-priv PortletAsyncContext
context

pack-priv ResourceRequest
request

pack-priv ResourceResponse
response

pack-priv Throwable
throwable

Constructor Summary

AccessConstructor and Description
public
PortletAsyncEvent(PortletAsyncContext context, ResourceRequest request, ResourceResponse response, Throwable throwable)

Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, ResourceResponse, and Throwable.
public
PortletAsyncEvent(PortletAsyncContext context, ResourceRequest request, ResourceResponse response)

Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, and ResourceResponse.
public
PortletAsyncEvent(PortletAsyncContext context, Throwable throwable)

Constructs a PortletAsyncEvent from the given PortletAsyncContext and Throwable.
public
PortletAsyncEvent(PortletAsyncContext context)

Constructs a PortletAsyncEvent from the given PortletAsyncContext.

Method Summary

Modifier and TypeMethod and Description
public PortletAsyncContext

Returns:

the portlet asynchronous context
getPortletAsyncContext()

Gets the portlet asynchronous context object associated with the event.
public ResourceRequest

Returns:

the resource request provided to the constructor, or null if no resource request was provided.
getSuppliedRequest()

Gets the resource request associated with the listener when it was added through the PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) method.
public ResourceResponse

Returns:

the resource response provided to the constructor, or null if no resource response was provided.
getSuppliedResponse()

Gets the resource response associated with the listener when it was added through the PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) method.
public Throwable

Returns:

The Throwable that was used to initialize the event, or null if no Throwable was provided.
getThrowable()

Gets the Throwable associated with the event.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

contextback to summary
pack-priv PortletAsyncContext context
requestback to summary
pack-priv ResourceRequest request
responseback to summary
pack-priv ResourceResponse response
throwableback to summary
pack-priv Throwable throwable

Constructor Detail

PortletAsyncEventback to summary
public PortletAsyncEvent(PortletAsyncContext context, ResourceRequest request, ResourceResponse response, Throwable throwable)

Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, ResourceResponse, and Throwable.
PortletAsyncEventback to summary
public PortletAsyncEvent(PortletAsyncContext context, ResourceRequest request, ResourceResponse response)

Constructs a PortletAsyncEvent from the given PortletAsyncContext, ResourceRequest, and ResourceResponse.
PortletAsyncEventback to summary
public PortletAsyncEvent(PortletAsyncContext context, Throwable throwable)

Constructs a PortletAsyncEvent from the given PortletAsyncContext and Throwable.
PortletAsyncEventback to summary
public PortletAsyncEvent(PortletAsyncContext context)

Constructs a PortletAsyncEvent from the given PortletAsyncContext.

Method Detail

getPortletAsyncContextback to summary
public PortletAsyncContext getPortletAsyncContext()

Gets the portlet asynchronous context object associated with the event.
Returns:PortletAsyncContext

the portlet asynchronous context

getSuppliedRequestback to summary
public ResourceRequest getSuppliedRequest()

Gets the resource request associated with the listener when it was added through the PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) method.

If the listener was added through the PortletAsyncContext#addListener(PortletAsyncListener) method, the returned resource request will be null.

Returns:ResourceRequest

the resource request provided to the constructor, or null if no resource request was provided.

getSuppliedResponseback to summary
public ResourceResponse getSuppliedResponse()

Gets the resource response associated with the listener when it was added through the PortletAsyncContext#addListener(PortletAsyncListener, ResourceRequest, ResourceResponse) method.

If the listener was added through the PortletAsyncContext#addListener(PortletAsyncListener) method, the returned resource response will be null.

Returns:ResourceResponse

the resource response provided to the constructor, or null if no resource response was provided.

getThrowableback to summary
public Throwable getThrowable()

Gets the Throwable associated with the event.
Returns:Throwable

The Throwable that was used to initialize the event, or null if no Throwable was provided.