org.gatein.wsrp.consumer.handlers

Class ActionHandler

java.lang.Object

org.gatein.wsrp.consumer.handlers.InvocationHandler<Invocation,Request,Response>

org.gatein.wsrp.consumer.handlers.NavigationalStateUpdatingHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

org.gatein.wsrp.consumer.handlers.ActionHandler

public class ActionHandler
extends NavigationalStateUpdatingHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

Since:

2.4 (May 31, 2006)

Version:

$Revision: 13121 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionHandler.RequestContextWrapper

Nested classes/interfaces inherited from class org.gatein.wsrp.consumer.handlers.InvocationHandler

InvocationHandler.RequestPrecursor<Invocation extends org.gatein.pc.api.invocation.PortletInvocation>

Field Summary

Fields inherited from class org.gatein.wsrp.consumer.handlers.InvocationHandler

consumer, debug, log, trace

Constructor Summary

Constructors

Constructor and Description
ActionHandler(WSRPConsumerImpl consumer)

Method Summary

Methods

Modifier and Type	Method and Description
protected List<Extension>	getExtensionsFrom(BlockingInteractionResponse blockingInteractionResponse) Extracts extensions from the response.
protected RuntimeContext	getRuntimeContextFrom(PerformBlockingInteraction performBlockingInteraction) Extracts the RuntimeContext from the specific WSRP request.
protected BlockingInteractionResponse	performRequest(PerformBlockingInteraction interaction) Performs the actual specific WSRP call for the specified request.
protected PerformBlockingInteraction	prepareRequest(InvocationHandler.RequestPrecursor<org.gatein.pc.api.invocation.ActionInvocation> requestPrecursor, org.gatein.pc.api.invocation.ActionInvocation invocation) Created and further prepares the specific requests based on common extracted information from the specified RequestPrecursor and the originating portlet invocation.
protected org.gatein.pc.api.invocation.response.PortletInvocationResponse	processResponse(BlockingInteractionResponse response, org.gatein.pc.api.invocation.ActionInvocation invocation, InvocationHandler.RequestPrecursor<org.gatein.pc.api.invocation.ActionInvocation> requestPrecursor) Converts the WSRP response into a portlet container PortletInvocationResponse based on its type and on whether other WSRP components need to be informed of potential changes from the producer.

Methods inherited from class org.gatein.wsrp.consumer.handlers.NavigationalStateUpdatingHandler

processUpdateResponse

Methods inherited from class org.gatein.wsrp.consumer.handlers.InvocationHandler

handle, performRequest, processExtensions, unwrapWSRPError

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionHandler

public ActionHandler(WSRPConsumerImpl consumer)

Method Detail

getRuntimeContextFrom

protected RuntimeContext getRuntimeContextFrom(PerformBlockingInteraction performBlockingInteraction)

Description copied from class: InvocationHandler

Extracts the RuntimeContext from the specific WSRP request.

Specified by:

getRuntimeContextFrom in class InvocationHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

Parameters:

performBlockingInteraction - the request to extract a RuntimeContext from

Returns:

the RuntimeContext instance associated with the specified request

performRequest

protected BlockingInteractionResponse performRequest(PerformBlockingInteraction interaction)
                                              throws Exception

Description copied from class: InvocationHandler

Performs the actual specific WSRP call for the specified request.

Specified by:

performRequest in class InvocationHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

Parameters:

interaction - the WSRP request to perform

Returns:

the producer's response

Throws:

Exception

prepareRequest

protected PerformBlockingInteraction prepareRequest(InvocationHandler.RequestPrecursor<org.gatein.pc.api.invocation.ActionInvocation> requestPrecursor,
                                        org.gatein.pc.api.invocation.ActionInvocation invocation)

Description copied from class: InvocationHandler

Created and further prepares the specific requests based on common extracted information from the specified RequestPrecursor and the originating portlet invocation.

Specified by:

prepareRequest in class InvocationHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

Parameters:

requestPrecursor - the common extracted information for this request

invocation - the portlet invocation from which we're trying to perform a WSRP call

Returns:

the fully prepared request

processResponse

protected org.gatein.pc.api.invocation.response.PortletInvocationResponse processResponse(BlockingInteractionResponse response,
                                                                              org.gatein.pc.api.invocation.ActionInvocation invocation,
                                                                              InvocationHandler.RequestPrecursor<org.gatein.pc.api.invocation.ActionInvocation> requestPrecursor)
                                                                                   throws org.gatein.pc.api.PortletInvokerException

Description copied from class: InvocationHandler

Converts the WSRP response into a portlet container PortletInvocationResponse based on its type and on whether other WSRP components need to be informed of potential changes from the producer.

Specified by:

processResponse in class InvocationHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

Parameters:

response - the original WSRP response

invocation - the PortletInvocation that triggered the WSRP call

requestPrecursor - the request precursor information we extracted before performing the request

Returns:

the appropriate PortletInvocationResponse based on the WSRP producer's response

Throws:

org.gatein.pc.api.PortletInvokerException

getExtensionsFrom

protected List<Extension> getExtensionsFrom(BlockingInteractionResponse blockingInteractionResponse)

Description copied from class: InvocationHandler

Extracts extensions from the response.

Specified by:

getExtensionsFrom in class InvocationHandler<org.gatein.pc.api.invocation.ActionInvocation,PerformBlockingInteraction,BlockingInteractionResponse>

Parameters:

blockingInteractionResponse - the WSRP response to extract extensions from

Returns:

a potentially empty list of extensions for the specified response