org.gatein.wsrp.consumer

Class ProducerInfo

java.lang.Object

org.gatein.wsrp.SupportsLastModified

org.gatein.wsrp.consumer.ProducerInfo

public class ProducerInfo
extends SupportsLastModified

ProducerInfo handles the consumer's state with respect to its remote producer. It encapsulates all the information needed to access and properly interact with a remote producer. In this respect, ProducerInfo encapsulates all the persisted state of the consumer.

It records, in particular:

• the name assigned to this producer that is used to identify which consumer (PortletInvoker) by the FederatingPortletInvoker when it chooses which invoker to dispatch to
• the connection to the remote producer via its EndpointConfigurationInfo member
• the registration status and data that the remote producer requires using its RegistrationInfo member
• as well as all the information gathered from examining the ServiceDescription returned by the producer

The relation between a consumer and a producer is quite complex so it is usually cached to avoid having to retrieve and parse the producer's ServiceDescription for each WSRP operation. However, since this relation can evolve over time, it is also necessary to be able to refresh it depending on the information returned by the producer as the result of an interaction with it. In particular, the registration status might have changed or the cached information is staled. This updating of the producer metadata is performed by the detailedRefresh(boolean) method, which is the most important method of this class.

Since:

2.6

Version:

$Revision: 12692 $

Author:

Chris Laprun

Field Summary

Fields

Modifier and Type	Field and Description
static Integer	DEFAULT_CACHE_VALUE

Constructor Summary

Constructors

Constructor and Description
ProducerInfo(ConsumerRegistrySPI consumerRegistry)

Method Summary

Methods

Modifier and Type	Method and Description
void	deregister()
RefreshResult	detailedRefresh(boolean forceRefresh) Refreshes the producer's information from the service description if required.
boolean	equals(Object o)
void	eraseRegistrationInfo()
Map<String,org.gatein.pc.api.Portlet>	getAllPortletsMap()
EndpointConfigurationInfo	getEndpointConfigurationInfo()
RegistrationInfo	getExpectedRegistrationInfo()
Integer	getExpirationCacheSeconds()
String	getId()
org.gatein.pc.api.info.EventInfo	getInfoForEvent(QName name)
String	getKey()
int	getNumberOfPortlets()
org.gatein.pc.api.Portlet	getPortlet(org.gatein.pc.api.PortletContext portletContext) Retrieve (possibly from cache) the Portlet associated with the specified PortletContext.
Map<String,org.gatein.pc.api.Portlet>	getProducerOffereedPortletMap()
PortletPropertyDescriptionResponse	getPropertyDescriptionsFor(String portletHandle)
RegistrationContext	getRegistrationContext()
RegistrationInfo	getRegistrationInfo()
ConsumerRegistrySPI	getRegistry()
CookieProtocol	getRequiresInitCookie()
Set<String>	getSupportedCustomModes()
Set<String>	getSupportedCustomWindowStates()
Collection<String>	getSupportedOptions()
int	hashCode()
boolean	hasLocalRegistrationInfo()
boolean	isActive() Determines whether the associated consumer is active.
boolean	isModifyRegistrationRequired()
boolean	isRefreshNeeded(boolean considerCache)
boolean	isRegistered()
boolean	isRegistrationChecked()
boolean	isRegistrationRequired()
void	modifyRegistration()
void	modifyRegistration(boolean force)
boolean	refresh(boolean forceRefresh) Refreshes the producer's information from the service description if required.
void	register()
void	resetRegistration()
void	setActive(boolean active) Activates or de-activate this Consumer.
void	setActiveAndSave(boolean active)
void	setEndpointConfigurationInfo(EndpointConfigurationInfo endpointConfigurationInfo)
void	setExpirationCacheSeconds(Integer expirationCacheSeconds)
void	setId(String id)
void	setKey(String key)
void	setModifyRegistrationRequired(boolean modifyRegistrationRequired)
void	setRegistrationInfo(RegistrationInfo registrationInfo)
void	setSupportedOption(String option) Public for tests
String	toString()

Methods inherited from class org.gatein.wsrp.SupportsLastModified

getLastModified, modifyNow, modifyNowIfNeeded, now, setLastModified

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE_VALUE

public static final Integer DEFAULT_CACHE_VALUE

Constructor Detail

ProducerInfo

public ProducerInfo(ConsumerRegistrySPI consumerRegistry)

Method Detail

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getRegistry

public ConsumerRegistrySPI getRegistry()

getKey

public String getKey()

setKey

public void setKey(String key)

getSupportedCustomModes

public Set<String> getSupportedCustomModes()

getSupportedCustomWindowStates

public Set<String> getSupportedCustomWindowStates()

getEndpointConfigurationInfo

public EndpointConfigurationInfo getEndpointConfigurationInfo()

setEndpointConfigurationInfo

public void setEndpointConfigurationInfo(EndpointConfigurationInfo endpointConfigurationInfo)

getRegistrationInfo

public RegistrationInfo getRegistrationInfo()

setRegistrationInfo

public void setRegistrationInfo(RegistrationInfo registrationInfo)

isRegistered

public boolean isRegistered()

isRegistrationRequired

public boolean isRegistrationRequired()

isRegistrationChecked

public boolean isRegistrationChecked()

hasLocalRegistrationInfo

public boolean hasLocalRegistrationInfo()

isActive

public boolean isActive()

Determines whether the associated consumer is active.

setActive

public void setActive(boolean active)

Activates or de-activate this Consumer. Note that this shouldn't be called directly as ConsumersRegistry will handle activation.

getId

public String getId()

setId

public void setId(String id)

setActiveAndSave

public void setActiveAndSave(boolean active)

isModifyRegistrationRequired

public boolean isModifyRegistrationRequired()

setModifyRegistrationRequired

public void setModifyRegistrationRequired(boolean modifyRegistrationRequired)

getRequiresInitCookie

public CookieProtocol getRequiresInitCookie()

getExpectedRegistrationInfo

public RegistrationInfo getExpectedRegistrationInfo()

refresh

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

Refreshes the producer's information from the service description if required.

Parameters:

forceRefresh - whether or not to force a refresh regardless of whether one would have been required based on cache expiration

Returns:

true if the producer's information was just refreshed, false otherwise

Throws:

org.gatein.pc.api.PortletInvokerException - if registration was required but couldn't be achieved properly

detailedRefresh

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

Refreshes the producer's information from the service description if required.

Parameters:

forceRefresh - whether or not to force a refresh regardless of whether one would have been required based on cache expiration

Returns:

detailed information about the result of the refresh in the form of a RefreshResult object

Throws:

org.gatein.pc.api.PortletInvokerException - if registration was required but couldn't be achieved properly

getPortlet

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

Retrieve (possibly from cache) the Portlet associated with the specified PortletContext.

Parameters:

portletContext - the PortletContext identifying the portlet to be retrieved

Returns:

the Portlet associated with the specified PortletContext

Throws:

org.gatein.pc.api.PortletInvokerException - if no portlet with the specified PortletContext could be found or if an error happened while attempting to retrieve the portlet information from the remote producer if the portlet couldn't be resolved from the local cache

getProducerOffereedPortletMap

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

Throws:

org.gatein.pc.api.PortletInvokerException

getAllPortletsMap

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

Throws:

org.gatein.pc.api.PortletInvokerException

getNumberOfPortlets

public int getNumberOfPortlets()
                        throws org.gatein.pc.api.PortletInvokerException

Throws:

org.gatein.pc.api.PortletInvokerException

getExpirationCacheSeconds

public Integer getExpirationCacheSeconds()

setExpirationCacheSeconds

public void setExpirationCacheSeconds(Integer expirationCacheSeconds)

getRegistrationContext

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

Throws:

org.gatein.pc.api.PortletInvokerException

resetRegistration

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

Throws:

org.gatein.pc.api.PortletInvokerException

getPropertyDescriptionsFor

public PortletPropertyDescriptionResponse getPropertyDescriptionsFor(String portletHandle)

register

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

Throws:

org.gatein.pc.api.PortletInvokerException

deregister

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

Throws:

org.gatein.pc.api.PortletInvokerException

modifyRegistration

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

Throws:

org.gatein.pc.api.PortletInvokerException

modifyRegistration

public void modifyRegistration(boolean force)
                        throws org.gatein.pc.api.PortletInvokerException

Throws:

org.gatein.pc.api.PortletInvokerException

isRefreshNeeded

public boolean isRefreshNeeded(boolean considerCache)

eraseRegistrationInfo

public void eraseRegistrationInfo()

getInfoForEvent

public org.gatein.pc.api.info.EventInfo getInfoForEvent(QName name)

getSupportedOptions

public Collection<String> getSupportedOptions()

setSupportedOption

public void setSupportedOption(String option)

Public for tests

Parameters:

option - a valid WSRP 2 option String, see WSRP2Constants' OPTIONS_* fields for valid values.