org.apache.wsrp4j.producer.provider
Interface PortletRegistrationFilter

All Known Subinterfaces:
PortletRegistrationFilterWriter
All Known Implementing Classes:
PortletRegistrationFilterImpl

public interface PortletRegistrationFilter

This interface provides methods to inspect portlets that are accessible by a certain consumer.

Version:
1.1
Author:
Stefan Behl

Method Summary
 java.util.Iterator getAvailable(java.lang.String regHandle)
          Returns all portlet handles of portlets, a certain consumer (identified by regHandle) can utilize.
 boolean isAvailable(java.lang.String regHandle, java.lang.String portletHandle)
          Indicates whether a certain consumer is allowed to utilize the portlet identified by portletHandle or not.
 

Method Detail

getAvailable

java.util.Iterator getAvailable(java.lang.String regHandle)
Returns all portlet handles of portlets, a certain consumer (identified by regHandle) can utilize. Returns null if there are no entries for the provided regHandle.

Parameters:
regHandle - String representing the registration handle of a consumer
Returns:
Iterator of portlet handles

isAvailable

boolean isAvailable(java.lang.String regHandle,
                    java.lang.String portletHandle)
Indicates whether a certain consumer is allowed to utilize the portlet identified by portletHandle or not. Returns false if there is no entry for the provided handles.

Parameters:
regHandle - String representing the registration handle of a consumer
portletHandle - String representing the portlet handle of an portlet
Returns:
boolean indicating whether the consumer corresponding to regHandle is allowed to use the portlet identified by portletHandle