WSRPConsumer (GateIn WSRP Consumer 2.3.1.Final API)

All Superinterfaces:

org.gatein.pc.api.PortletInvoker, SessionEventListener

All Known Subinterfaces:

WSRPConsumerSPI

All Known Implementing Classes:

WSRPConsumerImpl
```
public interface WSRPConsumer
extends org.gatein.pc.api.PortletInvoker, SessionEventListener
```
A PortletInvoker implementation proxying a remote producer on behalf of the local portal, translating portal calls to portlets into WSRP operations on the remote producer and translating the remote producer's responses back to portlet container structure so that the local portal thinks it's interacting with local portlets.

Since:

2.4

Version:

$Revision: 8782 $

Author:

Boleslaw Dawidowicz, 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
`void`	`activate()` Prepares this Consumer to be used: service is started, endpoints are ready.
`void`	`deactivate()` Removes this Consumer from service.
`ExportInfo`	`exportPortlets(List<String> portletHandles)` Asks the remote producer to export the specified portlets.
`MigrationService`	`getMigrationService()` Retrieves the MigrationService associated with this consumer.
`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.
`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.
`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?
`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
`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.

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
  - getProducerId
```
String getProducerId()
```
    Retrieves the identifier for the producer this consumer is associated with.
    
    Returns:
    the identifier of the associated producer
  - getProducerSessionInformationFrom
```
ProducerSessionInformation getProducerSessionInformationFrom(org.gatein.pc.api.invocation.PortletInvocation invocation)
```
    Retrieves the session information for the producer associated with this consumer.
    
    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
```
ProducerSessionInformation getProducerSessionInformationFrom(javax.servlet.http.HttpSession session)
```
    Retrieves the session information for the producer associated with this consumer.
    
    Parameters:
    session - the session from the information should be extracted.
    
    Returns:
    the session information for the producer associated with this consumer.
    See Also:
    ProducerSessionInformation
  - getProducerInfo
```
ProducerInfo getProducerInfo()
```
    Retrieves the ProducerInfo associated with this consumer.
    
    Returns:
    the ProducerInfo associated with this consumer.
    Since:
    
    2.6
  - refreshProducerInfo
```
void refreshProducerInfo()
                         throws org.gatein.pc.api.PortletInvokerException
```
    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.
    
    Throws:
    
    org.gatein.pc.api.PortletInvokerException
    Since:
    
    2.6
  - releaseSessions
```
void releaseSessions()
                     throws org.gatein.pc.api.PortletInvokerException
```
    Releases all the sessions held by this Consumer
    
    Throws:
    
    org.gatein.pc.api.PortletInvokerException
    Since:
    
    2.6
  - activate
```
void activate()
              throws Exception
```
    Prepares this Consumer to be used: service is started, endpoints are ready.
    
    Throws:
    
    Exception
    Since:
    
    2.6
  - deactivate
```
void deactivate()
                throws Exception
```
    Removes this Consumer from service. It cannot be used before being activated again.
    
    Throws:
    
    Exception
    Since:
    
    2.6
  - isRefreshNeeded
```
boolean isRefreshNeeded()
```
    Determines whether this consumer's information needs to be refreshed with respect to its associated remote producer.
    
    Returns:
    true if this consumer needs to be refreshed, false otherwise
    Since:
    
    2.6
  - refresh
```
RefreshResult refresh(boolean forceRefresh)
                      throws org.gatein.pc.api.PortletInvokerException
```
    Refreshes this consumer, potentially bypassing any cache, from the associated remote producer.
    
    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
    Since:
    
    2.6
  - start
```
void start()
           throws Exception
```
    Gets this consumer ready to receive and send WSRP messages to the remote producer.
    
    Throws:
    
    Exception
  - stop
```
void stop()
          throws Exception
```
    Stops this consumer, making it unable to send or receive WSRP messages.
    
    Throws:
    
    Exception
  - exportPortlets
```
ExportInfo exportPortlets(List<String> portletHandles)
                          throws org.gatein.pc.api.PortletInvokerException
```
    Asks the remote producer to export the specified portlets.
    
    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
```
void releaseExport(ExportInfo exportInfo)
                   throws org.gatein.pc.api.PortletInvokerException
```
    Tells the remote producer that we don't need the data associated with the specified ExportInfo.
    
    Parameters:
    exportInfo - the metadata identifying the exported portlets we don't need anymore
    
    Throws:
    
    org.gatein.pc.api.PortletInvokerException
  - getMigrationService
```
MigrationService getMigrationService()
```
    Retrieves the MigrationService associated with this consumer.
    
    Returns:
    the MigrationService associated with this consumer.
  - isImportExportSupported
```
boolean isImportExportSupported()
```
    Do we support the WSRP 2 import/export functionality?
    
    Returns:
    true if import/export is supported by this consumer, false otherwise
  - importPortlets
```
ImportInfo importPortlets(ExportInfo exportInfo,
                        List<String> portlets)
                          throws org.gatein.pc.api.PortletInvokerException
```
    Imports the specified portlets as identified by their handles associated with a previous export operation as identified by the specified ExportInfo.
    
    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
```
boolean isUsingWSRP2()
```
    Is this consumer compatible with WSRP 2?
    
    Returns:
    true if this consumer uses WSRP 2, false otherwise

Interface WSRPConsumer

Field Summary

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

Method Summary

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

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

Method Detail

getProducerId

getProducerSessionInformationFrom

getProducerSessionInformationFrom

getProducerInfo

refreshProducerInfo

releaseSessions

activate

deactivate

isRefreshNeeded

refresh

start

stop

exportPortlets

releaseExport

getMigrationService

isImportExportSupported

importPortlets

isUsingWSRP2