org.gatein.wsrp.api.extensions

Class InvocationHandlerDelegate

java.lang.Object

org.gatein.wsrp.api.extensions.InvocationHandlerDelegate

public abstract class InvocationHandlerDelegate
extends Object

A delegate that can be used to intercept PortletInvocations and PortletInvocationReponses before they are processed either by the Consumer or Producer. While this is particularly useful to be able to add and process WSRP Extensions that are outside of the WSRP specification, delegates could certainly be used to do more. However, since they have access to raw data from the portal's internal, one must be very careful about what's being done to the invocations and responses as a wrong operation could possibly have disastrous results on the portal's behavior. It is therefore extremely recommended (though not currently enforced) to treat the access to PortletInvocation and PortletInvocationResponse objects as read-only.

On the Consumer side, the consumer InvocationHandlerDelegate can intercept the incoming PortletInvocation from the consumer portal before it is processed by the WSRP stack, i.e. before a WSRP request is sent to the remote producer. On the flip side, the response from the producer can be processed right after the WSRP stack is done with it but before it is processed by the consumer portal.

On the Producer side, the producer InvocationHandlerDelegate can intercept the PortletInvocation that has been created as a translation of the incoming WSRP request before it is sent to the producer portal's portlet container. The response from the portlet container can then be processed before it is handled by the WSRP stack to be sent back to the Consumer.

Author:

Chris Laprun

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONSUMER_DELEGATE_CLASSNAME
static String	PRODUCER_DELEGATE_CLASSNAME

Constructor Summary

Constructors

Constructor and Description
InvocationHandlerDelegate()

Method Summary

Methods

Modifier and Type	Method and Description
static InvocationHandlerDelegate	consumerDelegate() Retrieves the delegate on the Consumer side.
abstract void	processInvocation(org.gatein.pc.api.invocation.PortletInvocation invocation) Method to process the specified PortletInvocation before it is handled by the rest of the WSRP invocation chain.
abstract void	processInvocationResponse(org.gatein.pc.api.invocation.response.PortletInvocationResponse response, org.gatein.pc.api.invocation.PortletInvocation invocation) Method to process the specified PortletInvocationResponse before it is handled by the rest of the WSRP invocation chain.
static InvocationHandlerDelegate	producerDelegate() Retrieves the delegate on the Producer side.
static void	registerConsumerDelegate(InvocationHandlerDelegate delegate) Only public for testing purposes
static void	registerProducerDelegate(InvocationHandlerDelegate delegate) Only public for testing purposes

Methods inherited from class java.lang.Object

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

Field Detail

CONSUMER_DELEGATE_CLASSNAME

public static final String CONSUMER_DELEGATE_CLASSNAME

See Also:

Constant Field Values

PRODUCER_DELEGATE_CLASSNAME

public static final String PRODUCER_DELEGATE_CLASSNAME

See Also:

Constant Field Values

Constructor Detail

InvocationHandlerDelegate

public InvocationHandlerDelegate()

Method Detail

registerConsumerDelegate

public static void registerConsumerDelegate(InvocationHandlerDelegate delegate)

Only public for testing purposes

Parameters:

delegate -

registerProducerDelegate

public static void registerProducerDelegate(InvocationHandlerDelegate delegate)

Only public for testing purposes

Parameters:

delegate -

consumerDelegate

public static InvocationHandlerDelegate consumerDelegate()

Retrieves the delegate on the Consumer side.

Returns:

producerDelegate

public static InvocationHandlerDelegate producerDelegate()

Retrieves the delegate on the Producer side.

Returns:

processInvocation

public abstract void processInvocation(org.gatein.pc.api.invocation.PortletInvocation invocation)

Method to process the specified PortletInvocation before it is handled by the rest of the WSRP invocation chain. See the class documentation for more details.

Parameters:

invocation - the PortletInvocation to process (recommended to consider as read-only, used to extract information from, not modify)

processInvocationResponse

public abstract void processInvocationResponse(org.gatein.pc.api.invocation.response.PortletInvocationResponse response,
                             org.gatein.pc.api.invocation.PortletInvocation invocation)

Method to process the specified PortletInvocationResponse before it is handled by the rest of the WSRP invocation chain. See the class documentation for more details.

Parameters:

response - the PortletInvocationResponse to process (recommended to consider as read-only, used to extract information from, not modify)

invocation - the PortletInvocation that caused the specified PortletInvocationResponse (recommended to consider as read-only, used to extract information from, not modify)