org.gatein.wsrp.api.extensions

Interface ProducerExtensionAccessor

public interface ProducerExtensionAccessor

Manages access to extensions on the producer-side so that API clients can set and retrieve extensions before requests are processed or responses sent back to the consumer.

This API is meant to be called from the producer-side InvocationHandlerDelegate, which methods are called by the implementation before the producer calls the portlet targeted by the WSRP request and after the invocation on the portlet is made but before the WSRP response is sent to the consumer.

Author:

Chris Laprun

See Also:

InvocationHandlerDelegate

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestExtension(Class fromClass, UnmarshalledExtension extension) Adds the specified unmarshalled extension to the list of extensions associated with instances the specified WSRP request class before the request is processed by the producer's portlet container.
void	addResponseExtension(Class wsrpResponseClass, Object extension) Add the specified extension to be set to the targeted WSRP response class before it is sent to the consumer.
void	clear() Clears the currently held extensions.
List<UnmarshalledExtension>	getRequestExtensionsFor(Class targetClass) Retrieves the list of unmarshalled extensions currently associated with instances of the specified target consumer request class.
List<Extension>	getResponseExtensionsFor(Class wsrpResponseClass) Retrieves the extensions associated with the specified WSRP response class so that they can be set appropriately on the response sent to the consumer.

Method Detail

addRequestExtension

void addRequestExtension(Class fromClass,
                       UnmarshalledExtension extension)

Adds the specified unmarshalled extension to the list of extensions associated with instances the specified WSRP request class before the request is processed by the producer's portlet container.

Note that this method is mostly targeted at the internal implementation.

Parameters:

fromClass - the class to which extensions should be associated

extension - the unmarshalled extension to add to the specified request parameter

getRequestExtensionsFor

List<UnmarshalledExtension> getRequestExtensionsFor(Class targetClass)

Retrieves the list of unmarshalled extensions currently associated with instances of the specified target consumer request class.

Note that extensions can currently only be retrieved on InteractionParams, EventParams, MarkupParams or ResourceParams

Parameters:

targetClass - the class of request parameters for which extensions are to be retrieved

Returns:

the list of unmarshalled extensions currently associated with instances of the specified target consumer request class

getResponseExtensionsFor

List<Extension> getResponseExtensionsFor(Class wsrpResponseClass)

Retrieves the extensions associated with the specified WSRP response class so that they can be set appropriately on the response sent to the consumer.

Note that this method is mostly targeted at the internal implementation.

Parameters:

wsrpResponseClass - the class on which extensions are to be set

Returns:

the list of extensions associated with the specified WSRP response class so that they can be set appropriately on the response sent to the consumer.

addResponseExtension

void addResponseExtension(Class wsrpResponseClass,
                        Object extension)

Add the specified extension to be set to the targeted WSRP response class before it is sent to the consumer.

Note that currently, GateIn WSRP only processes extensions from MarkupResponse, BlockingInteractionResponse, HandleEventsResponse or ResourceResponse. These classes are the ones that contain the specific information pertaining to markup, interaction, resource or event responses.

Parameters:

wsrpResponseClass - the class of elements on which extensions need to be added before being sent to the producer

extension - the extension to be added in the form of a Element (strongly recommended) or a Serializable object

clear

void clear()

Clears the currently held extensions. This method is called once per request-response cycle by the internal implementation.