com.novell.afw.portal.proxy
Class EboPortletRegistryProxy

java.lang.Object
 |
 +--com.novell.afw.portal.proxy.EboPortletRegistryProxy

public class EboPortletRegistryProxy

extends Object

This is the Portlet Registry proxy class that provides methods to delegate portlet registration operations and portlet assignment operations to managed containers (i.e. the portlet container, the legacy component container, and in the near future, we will also support the WSRP container).

Since:

v5.0

See Also:

EbiPortletConsumerRegistry, EbiComponentRegistry, com.novell.afw.wsrp.consumer.api.EbiWSRPConsumerRegistry

Constructor Summary

EboPortletRegistryProxy(EbiPortalContext portalContext)
Constructor with EbiPortalContext as an input parameter.

EboPortletRegistryProxy(ServletContext context)
Constructor with ServletContext as an input parameter.

Method Summary

EbiPortletEntity	clonePortletEntity(EbiContext context, EbiPortletEntity entity) Clone a new portlet instance prepresented by EbiPortletEntity object from an existing portlet instance.
EbiPortletEntity	createPortletEntity(EbiContext context, EbiPortletRegistration portletReg, boolean clone) Creates a new portlet instance prepresented by EbiPortletEntity object.
EbiPortletEntity	createPortletEntity(EbiContext context, String portletID, boolean clone) Creates a new portlet instance prepresented by EbiPortletEntity object.
EbiPortletEntity	createPortletEntity(EbiContext context, String portletID, String instanceID) Creates a new portlet instance (a EbiPortletEntity object).
void	deregisterPortlet(EbiContext context, String portletID) De-registers a portlet from a valid portlet producer.
Collection	getPortletCategories(EbiPortalContext context) Gets a Collection of EbiCategoryInfo objects for all categories that are defined in the portal war's resourceset.
Collection	getPortletCategories(EbiPortalContext context, String[] categoryIDs) Gets a Collection of EbiCategoryInfo objects for the specified category IDs.
EbiPortletEntity	getPortletEntity(EbiContext context, String portletInstanceID) Gets an existing portlet instance, a EbiPortletEntity object, from the proxy registry.
EbiPortletEntity	getPortletEntity(EbiContext context, String portletID, String portletInstanceID) Gets an existing portlet instance, a EbiPortletEntity object, from the proxy registry.
EbiPortletEntity	getPortletEntity(EbiContext context, String portletID, String portletInstanceID, String containerType) Gets an existing portlet instance, a EbiPortletEntity object, from the portlet registry.
EbiPortletSettings	getPortletEntitySettings(EbiContext context, EbiPortletEntity entity) Gets the portlet settings for an existing portlet instance from persistence storage.
EbiPortletModel	getPortletModel(EbiContext context, String producerID, String portletName) Gets an EbiPortletModel object specified by ProducerID and PortletName.
EbiPortletModel	getPortletModel(EbiContext context, String producerID, String portletName, String containerType) Gets an EbiPortletModel object specified by ProducerID and PortletName and a container type.
Collection	getPortletModelList(EbiContext context) Gets a list of portlet model objects from consumer registries: portlet consumer registry, component registry, and WSRP consumer registry (not supported in v5.0).
Collection	getPortletModelList(EbiContext context, String producerID, String containerType) Gets a list of portlet model objects (one per portlet definition specified in portlet.xml) for the specified portlet producer.
EbiPortletRegistration	getPortletRegistration(EbiContext context, String portletID) Gets a EbiPortletRegistration object specified by a Portlet ID.
Collection	getPortletRegistrationList(EbiContext context) Gets a list of PortletRegistration objects for all registered portlets.
Collection	getPortletRegistrationList(EbiContext context, String producerID, String containerType) Gets a list of EbiPortletRegistration objects for all registered portlets.
EbiPortletSettings	getPortletRegistrationSettings(EbiContext context, EbiPortletRegistration pr) Gets the portlet settings for an existing portlet registration in persistence storage.
Collection	getRestrictedPortletRegistrationList(EbiContext context) Gets a restricted collection of portlet registrations/components that user has List access permission.
Collection	getRestrictedPortletRegistrationListByCategory(EbiContext context, String categoryID) Gets a Collection of EbiPortletRegistration objects for all portlet registrations by category ID.
EbiPortletSettings	getUpdateablePortletEntitySettings(EbiContext context, EbiPortletEntity entity) Gets an updateable portlet settings for an existing portlet instance from persistence storage.
EbiPortletSettings	getUpdateablePortletRegistrationSettings(EbiContext context, EbiPortletRegistration pr) Gets an updateable portlet settings for an existing portlet registration from persistence storage.
EbiPortletRegistration	registerPortlet(EbiContext context, EbiPortletModel pm) Registers a portlet from a valid portlet producer.
EbiPortletRegistration	registerPortlet(EbiContext context, EbiPortletModel portletModel, String portletID) Registers a portlet from a valid portlet producer.
void	storePortletEntitySettings(EbiContext context, EbiPortletEntity entity, EbiPortletSettings settings) Modifies the portlet settings of an existing portlet instance in persistence storage.
void	storePortletRegistrationSettings(EbiContext context, EbiPortletRegistration reg, EbiPortletSettings settings) Modifies the portlet settings of an existing portlet registration in persistence storage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EboPortletRegistryProxy

public EboPortletRegistryProxy(ServletContext context)

Constructor with ServletContext as an input parameter.

Parameters:

context - a ServletContext object.

Since:

v5.0

EboPortletRegistryProxy

public EboPortletRegistryProxy(EbiPortalContext portalContext)

Constructor with EbiPortalContext as an input parameter.

Parameters:

portalContext - a EbiPortalContext object.

Since:

v5.0

See Also:

EbiPortalContext

Method Detail

getPortletModelList

public Collection getPortletModelList(EbiContext context)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Gets a list of portlet model objects from consumer registries: portlet consumer registry, component registry, and WSRP consumer registry (not supported in v5.0).

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletModel objects.

Since:

v5.0

See Also:

EbiPortletConsumerRegistry, EbiComponentRegistry, com.novell.afw.wsrp.consumer.api.EbiWSRPConsumerRegistry, EbiPortletModel

getPortletModelList

public Collection getPortletModelList(EbiContext context,
                                      String producerID,
                                      String containerType)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Gets a list of portlet model objects (one per portlet definition specified in portlet.xml) for the specified portlet producer.

Parameters:

context - an EbiContext object.

producerID - a producer ID.

containerType - a container type.

Returns:

a Collection of EbiPortletModel objects.

Since:

v5.0

See Also:

EbiPortletConsumerRegistry, EbiComponentRegistry, com.novell.afw.wsrp.consumer.api.EbiWSRPConsumerRegistry, EbiPortletModel

getPortletModel

public EbiPortletModel getPortletModel(EbiContext context,
                                       String producerID,
                                       String portletName)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException,
                                       com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets an EbiPortletModel object specified by ProducerID and PortletName. If the ProducerID is not specified, then it tries to find a portlet located locally.

Parameters:

context - an EbiContext object.

producerID - a portlet producer identifier.

portletName - a portlet name.

Returns:

an EbiPortletModel object.

Since:

v5.0

See Also:

EbiPortletModel

getPortletModel

public EbiPortletModel getPortletModel(EbiContext context,
                                       String producerID,
                                       String portletName,
                                       String containerType)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException,
                                       com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets an EbiPortletModel object specified by ProducerID and PortletName and a container type. If ProducerID is not specified, then it tries to find a portlet located locally.

Parameters:

context - an EbiContext object.

producerID - a portlet producer identifier.

portletName - a portlet name.

containerType - a portlet container type, if set to null, it is assumed to be the portlet container

Returns:

a EbiPortletModel object.

Since:

v5.0

See Also:

EbiPortletModel

registerPortlet

public EbiPortletRegistration registerPortlet(EbiContext context,
                                              EbiPortletModel pm)
                                       throws EboUnrecoverableSystemException,
                                              EboSecurityException,
                                              com.novell.afw.portal.proxy.EboPortletRegistrationDuplicateException,
                                              com.novell.afw.portal.proxy.EboPortletDefinitionException

Registers a portlet from a valid portlet producer.

The portlet ID is not passed in by the caller, and will be generated by the consumer registry.

Parameters:

context - an EbiContext object.

pm - an EbiPortletModel object.

Returns:

an EbiPortletRegistration object that contains the assigned portletID.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletModel

registerPortlet

public EbiPortletRegistration registerPortlet(EbiContext context,
                                              EbiPortletModel portletModel,
                                              String portletID)
                                       throws EboUnrecoverableSystemException,
                                              EboSecurityException,
                                              com.novell.afw.portal.proxy.EboPortletRegistrationDuplicateException,
                                              com.novell.afw.portal.proxy.EboPortletDefinitionException

Registers a portlet from a valid portlet producer.

Parameters:

context - an EbiContext object.

portletModel - an EbiPortletModel object

portletID - a portlet identifier that is pre-assigned by the caller.

Returns:

an EbiPortletRegistration object that contains the assigned portletID.

Since:

v5.0

deregisterPortlet

public void deregisterPortlet(EbiContext context,
                              String portletID)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException,
                              com.novell.afw.portal.proxy.EboPortletRegistrationException,
                              com.novell.afw.portal.proxy.EboPortletDefinitionException

De-registers a portlet from a valid portlet producer.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier for a registered portlet.

Since:

v5.0

getPortletRegistration

public EbiPortletRegistration getPortletRegistration(EbiContext context,
                                                     String portletID)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException,
                                                     com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                                     com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets a EbiPortletRegistration object specified by a Portlet ID.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier.

Returns:

an EbiPortletRegistration object.

Since:

v5.0

See Also:

EbiPortletRegistration

getPortletRegistrationList

public Collection getPortletRegistrationList(EbiContext context)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets a list of PortletRegistration objects for all registered portlets.

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getPortletRegistrationList

public Collection getPortletRegistrationList(EbiContext context,
                                             String producerID,
                                             String containerType)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets a list of EbiPortletRegistration objects for all registered portlets.

Parameters:

context - an EbiContext object.

producerID - an producer identifier. if this is null, then the current war's servlet context name is used.

containerType - a portlet container type. if this is null, then it is assumed to be the portlet container.

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getRestrictedPortletRegistrationList

public Collection getRestrictedPortletRegistrationList(EbiContext context)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets a restricted collection of portlet registrations/components that user has List access permission.

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

getPortletCategories

public Collection getPortletCategories(EbiPortalContext context)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a Collection of EbiCategoryInfo objects for all categories that are defined in the portal war's resourceset.

Parameters:

context - an EbiPortalContext object.

Returns:

a Collection of EbiCategoryInfo objects.

Since:

v5.0

getPortletCategories

public Collection getPortletCategories(EbiPortalContext context,
                                       String[] categoryIDs)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a Collection of EbiCategoryInfo objects for the specified category IDs.

Parameters:

context - an EbiPortalContext object.

categoryIDs - a specified category IDs

Returns:

a Collection of EbiCategoryInfo objects.

Since:

v5.0

getRestrictedPortletRegistrationListByCategory

public Collection getRestrictedPortletRegistrationListByCategory(EbiContext context,
                                                                 String categoryID)
                                                          throws EboUnrecoverableSystemException,
                                                                 EboSecurityException

Gets a Collection of EbiPortletRegistration objects for all portlet registrations by category ID. The list is restricted to only the ones that the user has List access permission.

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            EbiPortletRegistration portletReg,
                                            boolean clone)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                            com.novell.afw.portal.proxy.EboPortletDefinitionException

Creates a new portlet instance prepresented by EbiPortletEntity object.

Parameters:

context - an EbiContext object.

portletReg - an EbiPortletRegistration object that represents a portlet registration.

clone - a boolean flag to tell whether a new portlet handle is assigned to the new instance or the original portlet handle is used.

Returns:

a EbiPortletEntity object for a newly assigned portlet instance.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletEntity

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            String portletID,
                                            boolean clone)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                            com.novell.afw.portal.proxy.EboPortletDefinitionException

Creates a new portlet instance prepresented by EbiPortletEntity object.

Parameters:

context - an EbiContext object.

portletID - a Portlet identifier.

clone - a boolean flag to tell whether a new portlet handle is assigned to the new instance or the original portlet handle is used.

Returns:

an EbiPortletEntity object specified by a portlet ID.

Since:

v5.0

See Also:

EbiPortletEntity

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            String portletID,
                                            String instanceID)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                            com.novell.afw.portal.proxy.EboPortletDefinitionException

Creates a new portlet instance (a EbiPortletEntity object).

Parameters:

context - an EbiContext object.

portletID - a Portlet identifier.

instanceID - a predefined portlet instance identifier.

Returns:

a EbiPortletEntity object specified by the portletModel object.

Since:

v5.0

getPortletEntity

public EbiPortletEntity getPortletEntity(EbiContext context,
                                         String portletInstanceID)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException,
                                         com.novell.afw.portal.proxy.EboPortletEntityException,
                                         com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                         com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets an existing portlet instance, a EbiPortletEntity object, from the proxy registry. This method does not apply to the legacy component container.

Parameters:

context - an EbiContext object.

portletInstanceID - a portlet instance identifier.

Returns:

a EbiPortletEntity object specified by the portlet instance identifier.

Since:

v5.0

See Also:

EbiPortletEntity

getPortletEntity

public EbiPortletEntity getPortletEntity(EbiContext context,
                                         String portletID,
                                         String portletInstanceID)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException,
                                         com.novell.afw.portal.proxy.EboPortletEntityException,
                                         com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                         com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets an existing portlet instance, a EbiPortletEntity object, from the proxy registry.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier.

portletInstanceID - a portlet instance identifier.

Returns:

a EbiPortletEntity object specified by the portlet instance identifier.

Since:

v5.0

See Also:

EbiPortletEntity

getPortletEntity

public EbiPortletEntity getPortletEntity(EbiContext context,
                                         String portletID,
                                         String portletInstanceID,
                                         String containerType)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException,
                                         com.novell.afw.portal.proxy.EboPortletEntityException,
                                         com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                         com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets an existing portlet instance, a EbiPortletEntity object, from the portlet registry.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier.

portletInstanceID - a portlet instance identifier.

containerType - a container type

Returns:

a EbiPortletEntity object specified by the portlet instance identifier.

Since:

v5.0

clonePortletEntity

public EbiPortletEntity clonePortletEntity(EbiContext context,
                                           EbiPortletEntity entity)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException,
                                           com.novell.afw.portal.proxy.EboPortletRegistrationException,
                                           com.novell.afw.portal.proxy.EboPortletDefinitionException

Clone a new portlet instance prepresented by EbiPortletEntity object from an existing portlet instance.

Parameters:

context - an EbiContext object.

entity - an EbiPortletEntity object.

Returns:

a clone EbiPortletEntity object with a newly assigned portlet handle.

Since:

v5.0

See Also:

EbiPortletEntity

getUpdateablePortletEntitySettings

public EbiPortletSettings getUpdateablePortletEntitySettings(EbiContext context,
                                                             EbiPortletEntity entity)
                                                      throws EboUnrecoverableSystemException,
                                                             EboSecurityException,
                                                             com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets an updateable portlet settings for an existing portlet instance from persistence storage.

Parameters:

context - an EbiContext object.

entity - an existing EbiPortletEntity object.

Returns:

an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

getPortletEntitySettings

public EbiPortletSettings getPortletEntitySettings(EbiContext context,
                                                   EbiPortletEntity entity)
                                            throws EboUnrecoverableSystemException,
                                                   EboSecurityException,
                                                   com.novell.afw.portal.proxy.EboPortletDefinitionException

Gets the portlet settings for an existing portlet instance from persistence storage.

Parameters:

context - an EbiContext object.

entity - an existing EbiPortletEntity object.

Returns:

an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

storePortletEntitySettings

public void storePortletEntitySettings(EbiContext context,
                                       EbiPortletEntity entity,
                                       EbiPortletSettings settings)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException,
                                       com.novell.afw.portal.proxy.EboPortletDefinitionException

Modifies the portlet settings of an existing portlet instance in persistence storage.

Parameters:

context - an EbiContext object.

entity - an existing EbiPortletEntity object.

settings - an EbiPortletSettings object that contains modified settings. To modify the settings in an EbiPortletSettings object, you must get an EbiPortletSettings object that is updateable. You can obtain an updateable object from the EbiPortletEntity object by calling getUpdateablePortletSettings() method.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

getUpdateablePortletRegistrationSettings

public EbiPortletSettings getUpdateablePortletRegistrationSettings(EbiContext context,
                                                                   EbiPortletRegistration pr)
                                                            throws EboUnrecoverableSystemException,
                                                                   EboSecurityException

Gets an updateable portlet settings for an existing portlet registration from persistence storage.

Parameters:

context - an EbiContext object.

pr - an existing EbiPortletRegistration object.

Returns:

an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletSettings

getPortletRegistrationSettings

public EbiPortletSettings getPortletRegistrationSettings(EbiContext context,
                                                         EbiPortletRegistration pr)
                                                  throws EboUnrecoverableSystemException,
                                                         EboSecurityException

Gets the portlet settings for an existing portlet registration in persistence storage.

Parameters:

context - an EbiContext object.

portletReg - an EbiPortletRegistration object.

Returns:

an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletSettings

storePortletRegistrationSettings

public void storePortletRegistrationSettings(EbiContext context,
                                             EbiPortletRegistration reg,
                                             EbiPortletSettings settings)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Modifies the portlet settings of an existing portlet registration in persistence storage.
Note: we do not support portlet registration settings for legacy components.

Parameters:

context - an EbiContext object.

reg - an existing EbiPortletRegistration object.

settings - an EbiPortletSettings object that contains modified settings. To modify the settings in an EbiPortletSettings object, you must get an EbiPortletSettings object that is updateable. You can obtain an updateable object from the EbiPortletRegistration object by calling getUpdateablePortletSettings() method.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletSettings