org.gatein.wsrp.api.extensions

Interface ConsumerExtensionAccessor

public interface ConsumerExtensionAccessor

Accessor for consumer-side extensions. Use addRequestExtension(Class, Object) to add extensions to the request before it is sent to the producer. Use getResponseExtensionsFrom(Class) to retrieve the extensions that the producer might have sent back in its response.

Version:

$Revision$

Author:

Chris Laprun

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestExtension(Class targetClass, Object extension) Adds an extension before it is sent to the producer to elements of the specified target class.
void	addResponseExtension(Class responseClass, UnmarshalledExtension extension) Adds the specified unmarshalled extension to be linked to the specified WSRP response class.
void	clear() Clears the currently held extensions.
List<Extension>	getRequestExtensionsFor(Class targetClass) Retrieves previously set extensions targeted at the specified WSRP 2 target class so that the consumer can add them to the requests before sending them to the producer.
List<UnmarshalledExtension>	getResponseExtensionsFrom(Class responseClass) Retrieves extensions that were sent by the producer for instances of the specified response class.

Method Detail

getRequestExtensionsFor

List<Extension> getRequestExtensionsFor(Class targetClass)

Retrieves previously set extensions targeted at the specified WSRP 2 target class so that the consumer can add them to the requests before sending them to the producer. For examples, to retrieve extensions currently targeted to be added on MarkupParams, you would pass MarkupParams.class.

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

Parameters:

targetClass - the WSRP 2 class for which extensions are supposed to be retrieved, if any

Returns:

a List containing the Extensions needed to be added to the target class or an empty List if no such extension exists.

addRequestExtension

void addRequestExtension(Class targetClass,
                       Object extension)

Adds an extension before it is sent to the producer to elements of the specified target class.

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

Parameters:

targetClass - 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

getResponseExtensionsFrom

List<UnmarshalledExtension> getResponseExtensionsFrom(Class responseClass)

Retrieves extensions that were sent by the producer for instances of the specified response class.

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:

responseClass - the WSRP 2 response class for which extensions are to be retrieved.

Returns:

a List of UnmarshalledExtensions extracted from the specified response class

addResponseExtension

void addResponseExtension(Class responseClass,
                        UnmarshalledExtension extension)

Adds the specified unmarshalled extension to be linked to the specified WSRP response class.

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

Parameters:

responseClass - the WSRP response class (among those currently supported) to which extracted and unmarshalled extensions need to be added

extension - the extracted and unmarshalled extension to add

clear

void clear()

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