org.gatein.wsrp.consumer.spi

Interface WSRPConsumerSPI

All Superinterfaces:

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

All Known Implementing Classes:

WSRPConsumerImpl

public interface WSRPConsumerSPI
extends WSRPConsumer

Version:

$Revision$

Author:

Chris Laprun

Field Summary

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

LOCAL_PORTLET_INVOKER_ID

Method Summary

Methods

Modifier and Type	Method and Description
MarkupService	getMarkupService()
WSRPPortletInfo	getPortletInfo(org.gatein.pc.api.invocation.PortletInvocation invocation) Retrieves the WSRP-specific PortletInfo implementation for the portlet targeted by the specified invocation
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.
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.
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.
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.
boolean	supportsUserScope(String userScope) Determines whether the specified user scope (for markup caching) is supported.

Methods inherited from interface org.gatein.wsrp.WSRPConsumer

activate, deactivate, exportPortlets, getMigrationService, getProducerId, getProducerInfo, getProducerSessionInformationFrom, getProducerSessionInformationFrom, importPortlets, isImportExportSupported, isRefreshNeeded, isUsingWSRP2, refresh, refreshProducerInfo, releaseExport, releaseSessions, start, stop

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

createClone, destroyClones, exportPortlet, getPortlet, getPortlets, getProperties, getProperties, getStatus, importPortlet, invoke, isActive, setProperties

Methods inherited from interface org.gatein.wsrp.api.session.SessionEventListener

onSessionEvent

Method Detail

getRegistrationContext

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

Retrieves the current RegistrationContext if any

Returns:

the current RegistrationContext if any

Throws:

org.gatein.pc.api.PortletInvokerException

getUserContextFrom

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

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

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

getSessionHandler

SessionHandler getSessionHandler()

Retrieves the SessionHandler associated with this consumer.

Returns:

the SessionHandler associated with this consumer

setTemplatesIfNeeded

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

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

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

handleInvalidRegistrationFault

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

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

Throws:

org.gatein.pc.api.PortletInvokerException

getMarkupService

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

Throws:

org.gatein.pc.api.PortletInvokerException

supportsUserScope

boolean supportsUserScope(String userScope)

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

Parameters:

userScope - the user scope which support is to be determined

Returns:

true if the given user scope is supported, false otherwise

getPortletInfo

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

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

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

getSessionRegistry

SessionRegistry getSessionRegistry()

Retrieves the SessionRegistry associated with this consumer.

Returns:

the SessionRegistry associated with this consumer.

handleModifyRegistrationRequiredFault

void handleModifyRegistrationRequiredFault()

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