org.gatein.wsrp.consumer

Class WSRPConsumerImpl

java.lang.Object

org.gatein.wsrp.consumer.WSRPConsumerImpl

All Implemented Interfaces:

org.gatein.pc.api.PortletInvoker, SessionEventListener, WSRPConsumerSPI, WSRPConsumer

public class WSRPConsumerImpl
extends Object
implements WSRPConsumerSPI

WSRPConsumerImpl is in charge of maintaining the consumer's information with respect to its associated producer. This last bit is done using the ProducerInfo class. Portlet invocations are handled by an InvocationDispatcher which examines the invocation to decide which InvocationHandler will handle the request. The consumer also delegates session-related information to its SessionHandler instance. It takes care of portlet management functionality defined by the PortletInvoker interface, i.e. listing portlets it knows about, cloning portlet states, accessing or modifying portlet properties, etc., in essence, anything that's not directly related to portlet invocations. Finally, it deals with import / export functionality on the consumer side of things.

WSRP consumers are registered and managed by a ConsumerRegistry that takes care of configuring, persisting and dealing with consumers lifecycle.

Since:

2.4

Version:

$Revision: 11692 $

Author:

Boleslaw Dawidowicz, Chris Laprun

Field Summary

Fields inherited from interface org.gatein.pc.api.PortletInvoker

LOCAL_PORTLET_INVOKER_ID

Constructor Summary

Constructors

Constructor and Description
WSRPConsumerImpl(ProducerInfo info)

Method Summary

Methods

Modifier and Type	Method and Description
void	activate() Prepares this Consumer to be used: service is started, endpoints are ready.
org.gatein.pc.api.PortletContext	createClone(org.gatein.pc.api.PortletStateType stateType, org.gatein.pc.api.PortletContext portletContext)
void	deactivate() Removes this Consumer from service.
List<org.gatein.pc.api.state.DestroyCloneFailure>	destroyClones(List<org.gatein.pc.api.PortletContext> portletContexts)
boolean	equals(Object o)
org.gatein.pc.api.PortletContext	exportPortlet(org.gatein.pc.api.PortletStateType stateType, org.gatein.pc.api.PortletContext originalPortletContext)
ExportInfo	exportPortlets(List<String> portletHandles) Asks the remote producer to export the specified portlets.
static javax.servlet.http.HttpServletRequest	getHttpRequest(org.gatein.pc.api.invocation.PortletInvocation invocation) Utility method to extract the HttpServletRequest from the PortletInvocation.
static javax.servlet.http.HttpSession	getHttpSession(org.gatein.pc.api.invocation.PortletInvocation invocation) Gets the consumer HttpSession associated with the specified PortletInvocation.
MarkupService	getMarkupService()
MigrationService	getMigrationService() Retrieves the MigrationService associated with this consumer.
org.gatein.pc.api.Portlet	getPortlet(org.gatein.pc.api.PortletContext portletContext)
static org.gatein.pc.api.PortletContext	getPortletContext(org.gatein.pc.api.invocation.PortletInvocation invocation) Extracts the targeted portlet context from a given PortletInvocation
Map<String,Set<org.gatein.pc.api.Portlet>>	getPortletGroupMap()
WSRPPortletInfo	getPortletInfo(org.gatein.pc.api.invocation.PortletInvocation invocation) Retrieves the WSRP-specific PortletInfo implementation for the portlet targeted by the specified invocation
Set<org.gatein.pc.api.Portlet>	getPortlets()
String	getProducerId() Retrieves the identifier for the producer this consumer is associated with.
ProducerInfo	getProducerInfo() Retrieves the ProducerInfo associated with this consumer.
ProducerSessionInformation	getProducerSessionInformationFrom(javax.servlet.http.HttpSession session) Retrieves the session information for the producer associated with this consumer.
ProducerSessionInformation	getProducerSessionInformationFrom(org.gatein.pc.api.invocation.PortletInvocation invocation) Retrieves the session information for the producer associated with this consumer.
org.gatein.pc.api.state.PropertyMap	getProperties(org.gatein.pc.api.PortletContext portletContext)
org.gatein.pc.api.state.PropertyMap	getProperties(org.gatein.pc.api.PortletContext portletContext, Set<String> keys)
RegistrationContext	getRegistrationContext() Retrieves the current RegistrationContext if any
SessionHandler	getSessionHandler() Retrieves the SessionHandler associated with this consumer.
SessionRegistry	getSessionRegistry() Retrieves the SessionRegistry associated with this consumer.
org.gatein.pc.api.PortletStatus	getStatus(org.gatein.pc.api.PortletContext portletContext)
Set	getSupportedUserScopes()
UserContext	getUserContextFrom(WSRPPortletInfo info, org.gatein.pc.api.invocation.PortletInvocation invocation, RuntimeContext runtimeContext) Retrieves the user context if needed by the portlet from the invocation.
org.gatein.common.util.Version	getWSRPVersion()
void	handleInvalidRegistrationFault() Performs required maintenance when the consumer receives an InvalidaRegistrationFault from the producer.
void	handleModifyRegistrationRequiredFault() Performs required operations when the consumer receives a ModifyRegistrationRequiredFault from the producer to get the consumer ready to call modifyRegistration.
int	hashCode()
org.gatein.pc.api.PortletContext	importPortlet(org.gatein.pc.api.PortletStateType stateType, org.gatein.pc.api.PortletContext originalPortletContext)
ImportInfo	importPortlets(ExportInfo exportInfo, List<String> portlets) Imports the specified portlets as identified by their handles associated with a previous export operation as identified by the specified ExportInfo.
org.gatein.pc.api.invocation.response.PortletInvocationResponse	invoke(org.gatein.pc.api.invocation.PortletInvocation invocation)
boolean	isActive()
boolean	isImportExportSupported() Do we support the WSRP 2 import/export functionality?
boolean	isRefreshNeeded() Determines whether this consumer's information needs to be refreshed with respect to its associated remote producer.
boolean	isUsingWSRP2() Is this consumer compatible with WSRP 2?
void	onSessionEvent(SessionEvent event)
RefreshResult	refresh(boolean forceRefresh) Refreshes this consumer, potentially bypassing any cache, from the associated remote producer.
void	refreshProducerInfo() Asks this consumer's ProducerInfo to refresh itself by querying the associated remote producer for its service description and parsing it, potentially triggering other WSRP operations such as registration if required.
void	releaseExport(ExportInfo exportInfo) Tells the remote producer that we don't need the data associated with the specified ExportInfo.
void	releaseSessions() Releases all the sessions held by this Consumer
org.gatein.pc.api.PortletContext	setProperties(org.gatein.pc.api.PortletContext portletContext, org.gatein.pc.api.state.PropertyChange[] changes)
void	setTemplatesIfNeeded(WSRPPortletInfo info, org.gatein.pc.api.invocation.PortletInvocation invocation, RuntimeContext runtimeContext) Adds templates (see http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-os-01.html#_Producer_URL_Writing) if required.
void	start() Gets this consumer ready to receive and send WSRP messages to the remote producer.
void	stop() Stops this consumer, making it unable to send or receive WSRP messages.
boolean	supportsUserScope(String userScope) Determines whether the specified user scope (for markup caching) is supported.

Methods inherited from class java.lang.Object

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

Constructor Detail

WSRPConsumerImpl

public WSRPConsumerImpl(ProducerInfo info)

Method Detail

getProducerInfo

public ProducerInfo getProducerInfo()

Description copied from interface: WSRPConsumer

Retrieves the ProducerInfo associated with this consumer.

Specified by:

getProducerInfo in interface WSRPConsumer

Returns:

the ProducerInfo associated with this consumer.

getPortlets

public Set<org.gatein.pc.api.Portlet> getPortlets()
                                           throws org.gatein.pc.api.InvokerUnavailableException

Specified by:

getPortlets in interface org.gatein.pc.api.PortletInvoker

Throws:

org.gatein.pc.api.InvokerUnavailableException

getPortlet

public org.gatein.pc.api.Portlet getPortlet(org.gatein.pc.api.PortletContext portletContext)
                                     throws IllegalArgumentException,
                                            org.gatein.pc.api.PortletInvokerException

Specified by:

getPortlet in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

getStatus

public org.gatein.pc.api.PortletStatus getStatus(org.gatein.pc.api.PortletContext portletContext)
                                          throws IllegalArgumentException,
                                                 org.gatein.pc.api.PortletInvokerException

Specified by:

getStatus in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

invoke

public org.gatein.pc.api.invocation.response.PortletInvocationResponse invoke(org.gatein.pc.api.invocation.PortletInvocation invocation)
                                                                       throws org.gatein.pc.api.PortletInvokerException

Specified by:

invoke in interface org.gatein.pc.api.PortletInvoker

Throws:

org.gatein.pc.api.PortletInvokerException

createClone

public org.gatein.pc.api.PortletContext createClone(org.gatein.pc.api.PortletStateType stateType,
                                           org.gatein.pc.api.PortletContext portletContext)
                                             throws IllegalArgumentException,
                                                    org.gatein.pc.api.PortletInvokerException,
                                                    UnsupportedOperationException

Specified by:

createClone in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

UnsupportedOperationException

destroyClones

public List<org.gatein.pc.api.state.DestroyCloneFailure> destroyClones(List<org.gatein.pc.api.PortletContext> portletContexts)
                                                                throws IllegalArgumentException,
                                                                       org.gatein.pc.api.PortletInvokerException,
                                                                       UnsupportedOperationException

Specified by:

destroyClones in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

UnsupportedOperationException

getProperties

public org.gatein.pc.api.state.PropertyMap getProperties(org.gatein.pc.api.PortletContext portletContext,
                                                Set<String> keys)
                                                  throws IllegalArgumentException,
                                                         org.gatein.pc.api.PortletInvokerException,
                                                         UnsupportedOperationException

Specified by:

getProperties in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

UnsupportedOperationException

getProperties

public org.gatein.pc.api.state.PropertyMap getProperties(org.gatein.pc.api.PortletContext portletContext)
                                                  throws IllegalArgumentException,
                                                         org.gatein.pc.api.PortletInvokerException,
                                                         UnsupportedOperationException

Specified by:

getProperties in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

UnsupportedOperationException

setProperties

public org.gatein.pc.api.PortletContext setProperties(org.gatein.pc.api.PortletContext portletContext,
                                             org.gatein.pc.api.state.PropertyChange[] changes)
                                               throws IllegalArgumentException,
                                                      org.gatein.pc.api.PortletInvokerException,
                                                      UnsupportedOperationException

Specified by:

setProperties in interface org.gatein.pc.api.PortletInvoker

Throws:

IllegalArgumentException

org.gatein.pc.api.PortletInvokerException

UnsupportedOperationException

exportPortlet

public org.gatein.pc.api.PortletContext exportPortlet(org.gatein.pc.api.PortletStateType stateType,
                                             org.gatein.pc.api.PortletContext originalPortletContext)
                                               throws org.gatein.pc.api.PortletInvokerException

Specified by:

exportPortlet in interface org.gatein.pc.api.PortletInvoker

Throws:

org.gatein.pc.api.PortletInvokerException

importPortlet

public org.gatein.pc.api.PortletContext importPortlet(org.gatein.pc.api.PortletStateType stateType,
                                             org.gatein.pc.api.PortletContext originalPortletContext)
                                               throws org.gatein.pc.api.PortletInvokerException

Specified by:

importPortlet in interface org.gatein.pc.api.PortletInvoker

Throws:

org.gatein.pc.api.PortletInvokerException

getProducerId

public String getProducerId()

Description copied from interface: WSRPConsumer

Retrieves the identifier for the producer this consumer is associated with.

Specified by:

getProducerId in interface WSRPConsumer

Returns:

the identifier of the associated producer

getSessionHandler

public SessionHandler getSessionHandler()

Description copied from interface: WSRPConsumerSPI

Retrieves the SessionHandler associated with this consumer.

Specified by:

getSessionHandler in interface WSRPConsumerSPI

Returns:

the SessionHandler associated with this consumer

getPortletGroupMap

public Map<String,Set<org.gatein.pc.api.Portlet>> getPortletGroupMap()
                                                              throws org.gatein.pc.api.PortletInvokerException

Throws:

org.gatein.pc.api.PortletInvokerException

getPortletContext

public static org.gatein.pc.api.PortletContext getPortletContext(org.gatein.pc.api.invocation.PortletInvocation invocation)

Extracts the targeted portlet context from a given PortletInvocation

Parameters:

invocation - the invocation which targeted portlet we want to identify

Returns:

the targeted portlet context

Since:

2.6

getPortletInfo

public WSRPPortletInfo getPortletInfo(org.gatein.pc.api.invocation.PortletInvocation invocation)
                               throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumerSPI

Retrieves the WSRP-specific PortletInfo implementation for the portlet targeted by the specified invocation

Specified by:

getPortletInfo in interface WSRPConsumerSPI

Parameters:

invocation - the invocation targeting the portlet we want info about

Returns:

the WSRP-specific PortletInfo implementation for the portlet targeted by the specified invocation

Throws:

org.gatein.pc.api.PortletInvokerException

getSupportedUserScopes

public Set getSupportedUserScopes()

supportsUserScope

public boolean supportsUserScope(String userScope)

Description copied from interface: WSRPConsumerSPI

Determines whether the specified user scope (for markup caching) is supported.

Specified by:

supportsUserScope in interface WSRPConsumerSPI

Parameters:

userScope - the user scope which support is to be determined

Returns:

true if the given user scope is supported, false otherwise

isImportExportSupported

public boolean isImportExportSupported()

Description copied from interface: WSRPConsumer

Do we support the WSRP 2 import/export functionality?

Specified by:

isImportExportSupported in interface WSRPConsumer

Returns:

true if import/export is supported by this consumer, false otherwise

handleInvalidRegistrationFault

public void handleInvalidRegistrationFault()
                                    throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumerSPI

Performs required maintenance when the consumer receives an InvalidaRegistrationFault from the producer. Notably, resets the registration status and check with the producer.

Specified by:

handleInvalidRegistrationFault in interface WSRPConsumerSPI

Throws:

org.gatein.pc.api.PortletInvokerException

getRegistrationContext

public RegistrationContext getRegistrationContext()
                                           throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumerSPI

Retrieves the current RegistrationContext if any

Specified by:

getRegistrationContext in interface WSRPConsumerSPI

Returns:

the current RegistrationContext if any

Throws:

org.gatein.pc.api.PortletInvokerException

getProducerSessionInformationFrom

public ProducerSessionInformation getProducerSessionInformationFrom(org.gatein.pc.api.invocation.PortletInvocation invocation)

Description copied from interface: WSRPConsumer

Retrieves the session information for the producer associated with this consumer.

Specified by:

getProducerSessionInformationFrom in interface WSRPConsumer

Parameters:

invocation - a portlet invocation from which the session information should be extracted.

Returns:

the session information for the producer associated with this consumer.

See Also:

ProducerSessionInformation

getProducerSessionInformationFrom

public ProducerSessionInformation getProducerSessionInformationFrom(javax.servlet.http.HttpSession session)

Description copied from interface: WSRPConsumer

Retrieves the session information for the producer associated with this consumer.

Specified by:

getProducerSessionInformationFrom in interface WSRPConsumer

Parameters:

session - the session from the information should be extracted.

Returns:

the session information for the producer associated with this consumer.

See Also:

ProducerSessionInformation

activate

public void activate()
              throws Exception

Description copied from interface: WSRPConsumer

Prepares this Consumer to be used: service is started, endpoints are ready.

Specified by:

activate in interface WSRPConsumer

Throws:

Exception

deactivate

public void deactivate()
                throws Exception

Description copied from interface: WSRPConsumer

Removes this Consumer from service. It cannot be used before being activated again.

Specified by:

deactivate in interface WSRPConsumer

Throws:

Exception

isActive

public boolean isActive()

Specified by:

isActive in interface org.gatein.pc.api.PortletInvoker

isRefreshNeeded

public boolean isRefreshNeeded()

Description copied from interface: WSRPConsumer

Determines whether this consumer's information needs to be refreshed with respect to its associated remote producer.

Specified by:

isRefreshNeeded in interface WSRPConsumer

Returns:

true if this consumer needs to be refreshed, false otherwise

refresh

public RefreshResult refresh(boolean forceRefresh)
                      throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumer

Refreshes this consumer, potentially bypassing any cache, from the associated remote producer.

Specified by:

refresh in interface WSRPConsumer

Parameters:

forceRefresh - whether we want to force the refresh (i.e. bypass potential caches).

Returns:

the result of the operation

Throws:

org.gatein.pc.api.PortletInvokerException

start

public void start()
           throws Exception

Description copied from interface: WSRPConsumer

Gets this consumer ready to receive and send WSRP messages to the remote producer.

Specified by:

start in interface WSRPConsumer

Throws:

Exception

stop

public void stop()
          throws Exception

Description copied from interface: WSRPConsumer

Stops this consumer, making it unable to send or receive WSRP messages.

Specified by:

stop in interface WSRPConsumer

Throws:

Exception

getMarkupService

public MarkupService getMarkupService()
                               throws org.gatein.pc.api.PortletInvokerException

Specified by:

getMarkupService in interface WSRPConsumerSPI

Throws:

org.gatein.pc.api.PortletInvokerException

refreshProducerInfo

public void refreshProducerInfo()
                         throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumer

Asks this consumer's ProducerInfo to refresh itself by querying the associated remote producer for its service description and parsing it, potentially triggering other WSRP operations such as registration if required.

Specified by:

refreshProducerInfo in interface WSRPConsumer

Throws:

org.gatein.pc.api.PortletInvokerException

releaseSessions

public void releaseSessions()
                     throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumer

Releases all the sessions held by this Consumer

Specified by:

releaseSessions in interface WSRPConsumer

Throws:

org.gatein.pc.api.PortletInvokerException

getUserContextFrom

public UserContext getUserContextFrom(WSRPPortletInfo info,
                             org.gatein.pc.api.invocation.PortletInvocation invocation,
                             RuntimeContext runtimeContext)
                               throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumerSPI

Retrieves the user context if needed by the portlet from the invocation.

Specified by:

getUserContextFrom in interface WSRPConsumerSPI

Parameters:

info - the portlet information for the portlet being interacted with, specifically used to see if the portlet stores the user context in the session

invocation - the portlet invocation

runtimeContext - the WSRP runtime context to check whether a session exists which would indicate that the user context is already in session

Returns:

the user context associated with the specified invocation or null if it's asserted that it's stored in the session so that it's not sent again

Throws:

org.gatein.pc.api.PortletInvokerException

setTemplatesIfNeeded

public void setTemplatesIfNeeded(WSRPPortletInfo info,
                        org.gatein.pc.api.invocation.PortletInvocation invocation,
                        RuntimeContext runtimeContext)
                          throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumerSPI

Adds templates (see http://docs.oasis-open.org/wsrp/v2/wsrp-2.0-spec-os-01.html#_Producer_URL_Writing) if required.

Specified by:

setTemplatesIfNeeded in interface WSRPConsumerSPI

Parameters:

info - the portlet information for the portlet being interacted with, to check if it requires templates

invocation - the portlet invocation

runtimeContext - the WSRP runtime context to which the templates need to be added

Throws:

org.gatein.pc.api.PortletInvokerException

getHttpRequest

public static javax.servlet.http.HttpServletRequest getHttpRequest(org.gatein.pc.api.invocation.PortletInvocation invocation)

Utility method to extract the HttpServletRequest from the PortletInvocation.

Parameters:

invocation - the invocation from which we want to get the underlying HttpServletRequest

Returns:

the HttpServletRequest underlying the specified portlet invocation

getHttpSession

public static javax.servlet.http.HttpSession getHttpSession(org.gatein.pc.api.invocation.PortletInvocation invocation)

Gets the consumer HttpSession associated with the specified PortletInvocation.

Parameters:

invocation - the PortletInvocation from which we want to extract the HttpSession

Returns:

the consumer HttpSession associated with the specified PortletInvocation.

onSessionEvent

public void onSessionEvent(SessionEvent event)

Specified by:

onSessionEvent in interface SessionEventListener

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

exportPortlets

public ExportInfo exportPortlets(List<String> portletHandles)
                          throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumer

Asks the remote producer to export the specified portlets.

Specified by:

exportPortlets in interface WSRPConsumer

Parameters:

portletHandles - a list of handles identifying portlets to be exported

Returns:

the metadata resulting of the export operation

Throws:

org.gatein.pc.api.PortletInvokerException

releaseExport

public void releaseExport(ExportInfo exportInfo)
                   throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumer

Tells the remote producer that we don't need the data associated with the specified ExportInfo.

Specified by:

releaseExport in interface WSRPConsumer

Parameters:

exportInfo - the metadata identifying the exported portlets we don't need anymore

Throws:

org.gatein.pc.api.PortletInvokerException

importPortlets

public ImportInfo importPortlets(ExportInfo exportInfo,
                        List<String> portlets)
                          throws org.gatein.pc.api.PortletInvokerException

Description copied from interface: WSRPConsumer

Imports the specified portlets as identified by their handles associated with a previous export operation as identified by the specified ExportInfo.

Specified by:

importPortlets in interface WSRPConsumer

Parameters:

exportInfo - the export metadata identifying which exported data we want to import from the remote producer

portlets - a list of handles identifying which portlets we want to import from the available exported portlets associated with the specified ExportInfo

Returns:

the metadata associated with the result of the import operation

Throws:

org.gatein.pc.api.PortletInvokerException

isUsingWSRP2

public boolean isUsingWSRP2()

Description copied from interface: WSRPConsumer

Is this consumer compatible with WSRP 2?

Specified by:

isUsingWSRP2 in interface WSRPConsumer

Returns:

true if this consumer uses WSRP 2, false otherwise

getMigrationService

public MigrationService getMigrationService()

Description copied from interface: WSRPConsumer

Retrieves the MigrationService associated with this consumer.

Specified by:

getMigrationService in interface WSRPConsumer

Returns:

the MigrationService associated with this consumer.

getWSRPVersion

public org.gatein.common.util.Version getWSRPVersion()

getSessionRegistry

public SessionRegistry getSessionRegistry()

Description copied from interface: WSRPConsumerSPI

Retrieves the SessionRegistry associated with this consumer.

Specified by:

getSessionRegistry in interface WSRPConsumerSPI

Returns:

the SessionRegistry associated with this consumer.

handleModifyRegistrationRequiredFault

public void handleModifyRegistrationRequiredFault()

Description copied from interface: WSRPConsumerSPI

Performs required operations when the consumer receives a ModifyRegistrationRequiredFault from the producer to get the consumer ready to call modifyRegistration.

Specified by:

handleModifyRegistrationRequiredFault in interface WSRPConsumerSPI