org.gatein.wsrp.consumer.handlers

Class InvocationHandler<Invocation extends org.gatein.pc.api.invocation.PortletInvocation,Request,Response>

java.lang.Object

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

Type Parameters:

Invocation - the type of PortletInvocation this InvocationHandler handles

Request - the type of WSRP request this InvocationHandler can translate to from a portlet container request

Response - the type of WSRP response this InvocationHandler can translate back to portlet container responses

Direct Known Subclasses:

MimeResponseHandler, NavigationalStateUpdatingHandler

public abstract class InvocationHandler<Invocation extends org.gatein.pc.api.invocation.PortletInvocation,Request,Response>
extends Object

Handles a specific type of PortletInvocation, translating it back and forth into WSRP-understable structures.

Since:

2.4 (May 31, 2006)

Version:

$Revision: 13121 $

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	InvocationHandler.RequestPrecursor<Invocation extends org.gatein.pc.api.invocation.PortletInvocation> Extracts basic required elements for all invocation requests.

Field Summary

Fields

Modifier and Type	Field and Description
protected WSRPConsumerSPI	consumer The consumer owning this handler
protected static boolean	debug
protected static org.slf4j.Logger	log
protected static boolean	trace

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InvocationHandler(WSRPConsumerSPI consumer)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract List<Extension>	getExtensionsFrom(Response response) Extracts extensions from the response.
protected abstract RuntimeContext	getRuntimeContextFrom(Request request) Extracts the RuntimeContext from the specific WSRP request.
org.gatein.pc.api.invocation.response.PortletInvocationResponse	handle(Invocation invocation) Translates a portlet container request into a WSRP request, calls the appropriate WSRP operation and translates the received response back into something the portlet container can deal with, taking care of any exception, dealing with the ones we can or transforming them into portlet container exceptions when we can't deal with them ourselves.
protected abstract Response	performRequest(Request request) Performs the actual specific WSRP call for the specified request.
protected Response	performRequest(Request request, org.gatein.pc.api.invocation.PortletInvocation invocation) Attempts to perform the specified request, taking care of setting and updating cookies if required, at most MAXIMUM_RETRY_NUMBER times to give the consumer the opportunity to react to specific errors (such as need to invoke initCookie or modifyRegistration) that can sometimes be recovered from.
protected abstract Request	prepareRequest(InvocationHandler.RequestPrecursor<Invocation> requestPrecursor, Invocation invocation) Created and further prepares the specific requests based on common extracted information from the specified RequestPrecursor and the originating portlet invocation.
protected void	processExtensions(Response response) Processes extensions, making them available if needed to the ConsumerExtensionAccessor.
protected abstract org.gatein.pc.api.invocation.response.PortletInvocationResponse	processResponse(Response response, Invocation invocation, InvocationHandler.RequestPrecursor<Invocation> 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.
protected org.gatein.pc.api.invocation.response.ErrorResponse	unwrapWSRPError(org.gatein.pc.api.invocation.response.ErrorResponse errorResponse) Attempts to unwrap nested errors to make them more palatable to users.

Methods inherited from class java.lang.Object

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

Field Detail

consumer

protected final WSRPConsumerSPI consumer

The consumer owning this handler

log

protected static org.slf4j.Logger log

debug

protected static boolean debug

trace

protected static boolean trace

Constructor Detail

InvocationHandler

protected InvocationHandler(WSRPConsumerSPI consumer)

Method Detail

handle

public org.gatein.pc.api.invocation.response.PortletInvocationResponse handle(Invocation invocation)
                                                                       throws org.gatein.pc.api.PortletInvokerException

Translates a portlet container request into a WSRP request, calls the appropriate WSRP operation and translates the received response back into something the portlet container can deal with, taking care of any exception, dealing with the ones we can or transforming them into portlet container exceptions when we can't deal with them ourselves. Follows the Template Method design pattern.

Parameters:

invocation - the initiating portlet container request that will be transformed into a WSRP request

Returns:

an appropriate PortletInvocationResponse translated from the WSRP response sent by the producer

Throws:

org.gatein.pc.api.PortletInvokerException

performRequest

protected Response performRequest(Request request,
                      org.gatein.pc.api.invocation.PortletInvocation invocation)
                           throws Exception

Attempts to perform the specified request, taking care of setting and updating cookies if required, at most MAXIMUM_RETRY_NUMBER times to give the consumer the opportunity to react to specific errors (such as need to invoke initCookie or modifyRegistration) that can sometimes be recovered from.

Parameters:

request - the request to perform

invocation - the PortletInvocation that initiated the current WSRP request

Returns:

the producer's reponse

Throws:

Exception

unwrapWSRPError

protected org.gatein.pc.api.invocation.response.ErrorResponse unwrapWSRPError(org.gatein.pc.api.invocation.response.ErrorResponse errorResponse)

Attempts to unwrap nested errors to make them more palatable to users.

Parameters:

errorResponse - the error response we're trying to make simpler

Returns:

hopefully, a simplified error response, one that more clearly identifies the root issue

getRuntimeContextFrom

protected abstract RuntimeContext getRuntimeContextFrom(Request request)

Extracts the RuntimeContext from the specific WSRP request.

Parameters:

request - the request to extract a RuntimeContext from

Returns:

the RuntimeContext instance associated with the specified request

performRequest

protected abstract Response performRequest(Request request)
                                    throws Exception

Performs the actual specific WSRP call for the specified request.

Parameters:

request - the WSRP request to perform

Returns:

the producer's response

Throws:

Exception

prepareRequest

protected abstract Request prepareRequest(InvocationHandler.RequestPrecursor<Invocation> requestPrecursor,
                     Invocation invocation)

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

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 abstract org.gatein.pc.api.invocation.response.PortletInvocationResponse processResponse(Response response,
                                                                              Invocation invocation,
                                                                              InvocationHandler.RequestPrecursor<Invocation> requestPrecursor)
                                                                                            throws org.gatein.pc.api.PortletInvokerException

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.

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 abstract List<Extension> getExtensionsFrom(Response response)

Extracts extensions from the response.

Parameters:

response - the WSRP response to extract extensions from

Returns:

a potentially empty list of extensions for the specified response

processExtensions

protected void processExtensions(Response response)

Processes extensions, making them available if needed to the ConsumerExtensionAccessor. Used by subclasses.