org.gatein.wsrp.handler

Class RequestHeaderClientHandler

java.lang.Object

org.gatein.wsrp.handler.RequestHeaderClientHandler

All Implemented Interfaces:

Handler<SOAPMessageContext>, SOAPHandler<SOAPMessageContext>

public class RequestHeaderClientHandler
extends Object
implements SOAPHandler<SOAPMessageContext>

A WS-level handler to intercept cookies returned from the remote producer responses and provide them back again to the producer when invoking WS operations.

Author:

Julien Viet, Chris Laprun

Constructor Summary

Constructors

Constructor and Description
RequestHeaderClientHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	close(MessageContext messageContext)
static String	createCoalescedCookieFromCurrentInfo()
static String	getCurrentGroupId() Retrieves the portlet group identifier, if any, associated with the portlets being interacted with.
static ProducerSessionInformation	getCurrentProducerSessionInformation() Retrieves the session metadata associated with the current interaction.
Set<QName>	getHeaders()
boolean	handleFault(SOAPMessageContext soapMessageContext)
boolean	handleMessage(SOAPMessageContext soapMessageContext)
boolean	handleRequest(SOAPMessageContext msgContext) Retrieves cookie information from currently held information and adds them to outbound (producer-bound) messages.
boolean	handleResponse(MessageContext msgContext) Extracts any cookie from the inbound (provider-issued) message and make this information available to other WSRP components via ProducerSessionInformation.
static void	resetCurrentInfo() Removes any data associated with the current interaction.
static void	setCurrentGroupId(String groupId) Specifies that the portlets being interacted with are part of the portlet group identified by the specified group identifier
static void	setCurrentInfo(String groupId, ProducerSessionInformation sessionInformation) Updates the information associated with the current interactions with the specified information.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestHeaderClientHandler

public RequestHeaderClientHandler()

Method Detail

getHeaders

public Set<QName> getHeaders()

Specified by:

getHeaders in interface SOAPHandler<SOAPMessageContext>

handleMessage

public boolean handleMessage(SOAPMessageContext soapMessageContext)

Specified by:

handleMessage in interface Handler<SOAPMessageContext>

handleFault

public boolean handleFault(SOAPMessageContext soapMessageContext)

Specified by:

handleFault in interface Handler<SOAPMessageContext>

close

public void close(MessageContext messageContext)

Specified by:

close in interface Handler<SOAPMessageContext>

handleRequest

public boolean handleRequest(SOAPMessageContext msgContext)

Retrieves cookie information from currently held information and adds them to outbound (producer-bound) messages.

Parameters:

msgContext - the SOAP message context to add cookies to

Returns:

true to continue processing, false otherwise (defined by Handler.handleMessage(javax.xml.ws.handler.MessageContext))

createCoalescedCookieFromCurrentInfo

public static String createCoalescedCookieFromCurrentInfo()

handleResponse

public boolean handleResponse(MessageContext msgContext)

Extracts any cookie from the inbound (provider-issued) message and make this information available to other WSRP components via ProducerSessionInformation.

Parameters:

msgContext - the inbound (provider-issued) message from which cookie information is extracted

Returns:

true to continue processing, false otherwise (defined by Handler.handleMessage(javax.xml.ws.handler.MessageContext))

setCurrentInfo

public static void setCurrentInfo(String groupId,
                  ProducerSessionInformation sessionInformation)

Updates the information associated with the current interactions with the specified information.

Parameters:

groupId - the portlet group identifier (if any) associated with the portlet(s) being interacted with

sessionInformation - the session metadata to associate with the current interaction

resetCurrentInfo

public static void resetCurrentInfo()

Removes any data associated with the current interaction.

getCurrentProducerSessionInformation

public static ProducerSessionInformation getCurrentProducerSessionInformation()

Retrieves the session metadata associated with the current interaction.

Returns:

the session metadata associated with the current interaction or null if none currently exists

getCurrentGroupId

public static String getCurrentGroupId()

Retrieves the portlet group identifier, if any, associated with the portlets being interacted with.

Returns:

the portlet group identifier associated with the portlets being interacted with or null if the portlets are not part of a group

setCurrentGroupId

public static void setCurrentGroupId(String groupId)

Specifies that the portlets being interacted with are part of the portlet group identified by the specified group identifier

Parameters:

groupId - the group identifier for the group the portlets being interacted with are part of