com.novell.afw.portlet.api
Interface EbiPortletConsumerRegistry

All Superinterfaces:

EbiConsumerRegistry

public interface EbiPortletConsumerRegistry

extends EbiConsumerRegistry

This is the Portlet Consumer Registry Interface. A EbiPortletConsumerRegistry object is instantiated by the factory and scoped at one per Portal application. A EbiPortletConsumerRegistry is responsible of providing methods to perform portlet application registrations for any available portlet producers that are running on the same application server instance. It also provides methods to perform portlet registrations for any portlets that are available from registered portlet producers.

Since:

v5.0

Field Summary

static String

PORTLET_CONSUMER_REGISTRY Service entriy key of the portlet consumer registry.

Method Summary

void	cleanOrphanPortletProducer(EbiContext context, String producerID) Cleans an orphan portlet producer and all related data from persistence store.
void	deregisterPortletProducer(EbiContext context, String producerID) De-register a portlet producer.
void	enablePortletProducer(EbiContext context, String producerID, boolean enable) Enables a portlet producer.
void	flushPortletProducer(String producerID) Flushes the information mgr for the specified portlet producer.
Collection	getOrphanPortletProducerList(EbiContext context) Gets a list of orphan portlet producers that are either no longer active from app/web server or are not a valid portlet applications.
EbiPortletInfoManager	getPortletInfoManager(String producerID) Gets a portlet info manager for a specified producer ID.
EbiPortletProducerInfo	getPortletProducerInfo(EbiContext context, String producerID, boolean flush) Gets an EbiPortletProducerInfo for a registered portlet producer from the portlet consumer registry.
Collection	getPortletProducerList(EbiContext context, boolean flush) Gets a list of registered portlet producers from the portlet consumer registry.
boolean	isPortletProducerAccessible(EbiContext context, String producerID) Checks if a portlet producer is accessible.
boolean	isPortletProducerEnabled(EbiContext context, String producerID) Checks if a portlet producer is enabled.
void	registerPortletProducer(EbiContext context, String producerID) Register a portlet producer.

Methods implemented from interface com.novell.afw.portlet.api.EbiConsumerRegistry

addPortletRegistrationToCategory, cleanOrphanPortletRegistration, clonePortletEntity, createPortletEntity, createPortletEntity, createPortletEntity, createPortletEntity, createPortletEntity, createPortletEntity, deregisterPortlet, flushPortletRegistrationSessionCache, getCategoriesByPortletRegistration, getOrphanPortletRegistrationList, getPortletEntity, getPortletEntitySettings, getPortletModel, getPortletModelList, getPortletModelList, getPortletRegistration, getPortletRegistrationList, getPortletRegistrationList, getPortletRegistrationList, getPortletRegistrationSettings, getRestrictedPortletRegistrationList, getRestrictedPortletRegistrationList, getRestrictedPortletRegistrationListByCategory, getRestrictedPortletRegistrationListByCategory, getUpdateablePortletEntitySettings, getUpdateablePortletRegistrationSettings, init, registerPortlet, registerPortlet, removePortletRegistrationFromCategories, removePortletRegistrationFromCategory, storePortletEntitySettings, storePortletRegistrationSettings

Field Detail

PORTLET_CONSUMER_REGISTRY

public static final String PORTLET_CONSUMER_REGISTRY

Service entriy key of the portlet consumer registry.

Since:

v5.0

Method Detail

getPortletProducerInfo

public EbiPortletProducerInfo getPortletProducerInfo(EbiContext context,
                                                     String producerID,
                                                     boolean flush)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException

Gets an EbiPortletProducerInfo for a registered portlet producer from the portlet consumer registry.

Parameters:

context - an EbiContext object.

producerID - a portlet producer identifier

flush - if set to true, it forces to get the data from persistent storage, instead of cache.

Returns:

an EbiPortletProducerInfo object for the specified portlet producer.

Since:

v5.0

See Also:

EbiPortletProducerInfo

registerPortletProducer

public void registerPortletProducer(EbiContext context,
                                    String producerID)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Register a portlet producer.

Parameters:

context - an EbiContext object.

producerID - a producer ID for a portlet producer to be registered. A producer ID should be the portlet application context name of the WAR for the portlet producer.

Since:

v5.0

deregisterPortletProducer

public void deregisterPortletProducer(EbiContext context,
                                      String producerID)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

De-register a portlet producer. Removes the portlet producer from persistent storage

Parameters:

context - an EbiContext object.

producerID - a producer ID for a portlet producer to be de-registered.

Since:

v5.0

enablePortletProducer

public void enablePortletProducer(EbiContext context,
                                  String producerID,
                                  boolean enable)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Enables a portlet producer.

Parameters:

context - an EbiContext object.

producerID - a producer ID for a portlet producer to be enabled

enable - true if enabling the portlet producer, false otherwise.

Since:

v5.0

getPortletProducerList

public Collection getPortletProducerList(EbiContext context,
                                         boolean flush)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException

Gets a list of registered portlet producers from the portlet consumer registry.

Parameters:

context - an EbiContext object.

flush - if set to true, it forces to get the list from the persistent storege, instead of cache.

Returns:

a Collection of EbiPortletProducerInfo objects for deployed portlet producers.

Since:

v5.0

See Also:

EbiPortletProducerInfo

getOrphanPortletProducerList

public Collection getOrphanPortletProducerList(EbiContext context)
                                        throws EboUnrecoverableSystemException,
                                               EboSecurityException

Gets a list of orphan portlet producers that are either no longer active from app/web server or are not a valid portlet applications.

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletProducerInfo objects.

Since:

v5.0

cleanOrphanPortletProducer

public void cleanOrphanPortletProducer(EbiContext context,
                                       String producerID)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Cleans an orphan portlet producer and all related data from persistence store.

Parameters:

context -

producerID -

Since:

v5.0

isPortletProducerAccessible

public boolean isPortletProducerAccessible(EbiContext context,
                                           String producerID)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException

Checks if a portlet producer is accessible.

Parameters:

context - an EbiContext object.

producerID - a producer ID for a portlet producer to be checked

Returns:

true if the portlet producer is accessible, false otherwise.

Since:

v5.0

isPortletProducerEnabled

public boolean isPortletProducerEnabled(EbiContext context,
                                        String producerID)
                                 throws EboUnrecoverableSystemException,
                                        EboSecurityException

Checks if a portlet producer is enabled.

Parameters:

context - an EbiContext object.

producerID - a producer ID for a portlet producer to be checked

Returns:

true if the portlet producer is enabled, false otherwise.

Since:

v5.0

getPortletInfoManager

public EbiPortletInfoManager getPortletInfoManager(String producerID)

Gets a portlet info manager for a specified producer ID.

Parameters:

producerID -

Returns:

a EbiPortletInfoManager object.

Since:

v5.0

See Also:

EbiPortletInfoManager

flushPortletProducer

public void flushPortletProducer(String producerID)

Flushes the information mgr for the specified portlet producer. Also flushes session caches for the restricted portlet registration list.

Parameters:

producerID - a producer ID for a portlet producer.

Since:

v5.2