org.apache.wsrp4j.producer.provider
Interface PortletRegistrationFilterWriter

All Superinterfaces:
PortletRegistrationFilter
All Known Implementing Classes:
PortletRegistrationFilterImpl

public interface PortletRegistrationFilterWriter
extends PortletRegistrationFilter

This interface provides methods to make portlets available to a certain consumer. If a certain consumer deregisters, the consumer registry is responsible for updating, i.e. removing the entries within the PortletRegistratinFilter component. If an portlet was removed, the portlet pool has to remove the affected entries by calling the provided remove-methods.

Version:
1.1
Author:
Stefan Behl

Method Summary
 void makeAvailable(java.lang.String regHandle, java.util.Iterator portletHandles)
          Makes several portlets (identified by portletHandles) available to a certain consumer (identified by regHandle).
 void makeAvailable(java.lang.String regHandle, java.lang.String portletHandle)
          Makes a certain portlet (identified by portletHandle) available to a consumer (identified by regHandle).
 void remove(java.lang.String regHandle)
          Removes an entire entry for a certain consumer (identified by regHandle).
 void remove(java.lang.String regHandle, java.util.Iterator portletHandles)
          Abrogates the availability of several portlets (identified by portletHandles) regarding a certain consumer (identified by regHandle).
 void remove(java.lang.String regHandle, java.lang.String portletHandle)
          Abrogates the availability of a certain portlet (identified by portletHandle) regarding a certain consumer (identified by regHandle).
 
Methods inherited from interface org.apache.wsrp4j.producer.provider.PortletRegistrationFilter
getAvailable, isAvailable
 

Method Detail

makeAvailable

void makeAvailable(java.lang.String regHandle,
                   java.lang.String portletHandle)
                   throws WSRPException
Makes a certain portlet (identified by portletHandle) available to a consumer (identified by regHandle). If there is no portlet in the portlet pool that corresponds to portletHandle, the method performs nothing.

Parameters:
regHandle - String representing the registration handle of a consumer
portletHandle - String representing the portlet handle of a consumer
Throws:
WSRPException

makeAvailable

void makeAvailable(java.lang.String regHandle,
                   java.util.Iterator portletHandles)
                   throws WSRPException
Makes several portlets (identified by portletHandles) available to a certain consumer (identified by regHandle). For portlet handles that do not correspond to portlets kept within the portlet pool, the method makes no availability-entry.

Parameters:
regHandle - String representing the registration handle of a consumer
portletHandles - Iterator containing some portlet handles of portlets
Throws:
WSRPException

remove

void remove(java.lang.String regHandle)
Removes an entire entry for a certain consumer (identified by regHandle). If there are no entries for the provided regHandle, the method performs nothing. The method is useful when a consumer deregisters.

Parameters:
regHandle - String representing the registration handle of a consumer

remove

void remove(java.lang.String regHandle,
            java.lang.String portletHandle)
            throws WSRPException
Abrogates the availability of a certain portlet (identified by portletHandle) regarding a certain consumer (identified by regHandle). If there is no entry for the provided regHandle and portletHandle, the method performs nothing.

Parameters:
regHandle - String representing the registration handle of a consumer
portletHandle - String representing the portlet handle of a consumer
Throws:
WSRPException

remove

void remove(java.lang.String regHandle,
            java.util.Iterator portletHandles)
            throws WSRPException
Abrogates the availability of several portlets (identified by portletHandles) regarding a certain consumer (identified by regHandle). For portlet handles that do not correspond to portlets kept within the portlet pool, the method performs nothing.

Parameters:
regHandle - String representing the registration handle of a consumer
portletHandles - Iterator containing some portlet handles of portlets
Throws:
WSRPException