com.novell.afw.portlet.api
Interface EbiConsumerRegistry

All Known Subinterfaces:

EbiPortletConsumerRegistry

public interface EbiConsumerRegistry

This is basic Consumer Registry Interface. A EbiConsumerRegistry object is instantiated by the factory and scoped at one per Portal application. A EbiPortletConsumerRegistry is responsible of providing methods to perform portlet registrations for any portlets that are available from registered portlet producers and wsrp producers; and assign portlet instances.

Since:

v5.2

Method Summary

void	addPortletRegistrationToCategory(EbiContext context, String portletID, String categoryID) Adds a portlet registration to a portlet category.
void	cleanOrphanPortletRegistration(EbiContext context, String portletID) Cleans an orphan portlet registration and all related data from persistent store.
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) Creates a new portlet instance prepresented by EbiPortletEntity object.
EbiPortletEntity	createPortletEntity(EbiContext context, EbiPortletRegistration portletReg, boolean clone) Creates a new portlet instance prepresented by EbiPortletEntity object.
EbiPortletEntity	createPortletEntity(EbiContext context, EbiPortletRegistration portletReg, String instanceID) Creates a new portlet instance prepresented by EbiPortletEntity object with pre-assigned portlet instance ID.
EbiPortletEntity	createPortletEntity(EbiContext context, String portletID) 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) with pre-assigned portlet instance ID.
void	deregisterPortlet(EbiContext context, String portletID) De-registers a portlet from a valid portlet producer.
void	flushPortletRegistrationSessionCache() Flushes session caches for the restricted portlet registration list.
String[]	getCategoriesByPortletRegistration(EbiContext context, String portletID) Gets a list of portlet categories by a portlet registration.
Collection	getOrphanPortletRegistrationList(EbiContext context, String producerID) Gets a list of orphan portlet registrations that belong to a portlet application that is no longer available from the app/web server.
EbiPortletEntity	getPortletEntity(EbiContext context, String instanceID) Gets an existing EbiPortletEntity object from the consumer 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 a EbiPortletModel object specified by ProducerID and PortletName.
Collection	getPortletModelList(EbiContext context) Gets a collection of available portlets for consumer registries: portlet consumer registry, component registry, and WSRP consumer registry (optional).
Collection	getPortletModelList(EbiContext context, String producerID) Gets a collection 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 EbiPortletRegistration objects for all registered portlets.
Collection	getPortletRegistrationList(EbiContext context, String producerID) Gets a list of EbiPortletRegistration objects for all registered portlets.
Collection	getPortletRegistrationList(EbiContext context, String producerID, String portletName) Gets a list of EbiPortletRegistration objects for all registered portlets that are associated with a specified portlet definition.
EbiPortletSettings	getPortletRegistrationSettings(EbiContext context, EbiPortletRegistration pr) Gets the portlet settings for an existing portlet registration in persistence storage.
Collection	getRestrictedPortletRegistrationList(EbiContext context) Gets a filtered list of EbiPortletRegistration objects for registered portlets that the authenticated user from EbiContext is allowed to access with LIST permission.
Collection	getRestrictedPortletRegistrationList(EbiContext context, String producerID) Gets a filtered list of EbiPortletRegistration objects for registered portlets that the authenticated user from EbiContext is allowed to access with the LIST permission.
Collection	getRestrictedPortletRegistrationListByCategory(EbiContext context, String categoryID) Gets a filtered list of EbiPortletRegistration objects for registered portlets by category ID that the authenticated user from EbiContext is allowed to access with the LIST permission.
Collection	getRestrictedPortletRegistrationListByCategory(EbiContext context, String producerID, String categoryID) Gets a filtered list of EbiPortletRegistration objects for registered portlets by category ID and producerID that the authenticated user from EbiContext is allowed to access with the LIST permission.
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 in persistence storage.
void	init(ServletContext context) Initializes the WSRP Consumer registry.
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	removePortletRegistrationFromCategories(EbiContext context, String portletID) Removes a portlet registration from all portlet categories.
void	removePortletRegistrationFromCategory(EbiContext context, String portletID, String categoryID) Removes a portlet registration from a portlet category.
void	storePortletEntitySettings(EbiContext context, EbiPortletEntity entity, EbiPortletSettings settings) Sets the portlet settings for an existing portlet instance in persistence storage.
void	storePortletRegistrationSettings(EbiContext context, EbiPortletRegistration portletReg, EbiPortletSettings settings) Sets the portlet settings for an existing portlet registration in persistence storage.

Method Detail

init

public void init(ServletContext context)
          throws EboUnrecoverableSystemException

Initializes the WSRP Consumer registry.

Since:

v5.0

getPortletModelList

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

Gets a collection 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.

Returns:

a Collection of EbiPortletModel objects.

Since:

v5.0

See Also:

EbiPortletModel

getPortletModelList

public Collection getPortletModelList(EbiContext context)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Gets a collection of available portlets for consumer registries: portlet consumer registry, component registry, and WSRP consumer registry (optional).

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletModel objects.

Since:

v5.0

See Also:

EbiPortletModel

getPortletModel

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

Gets a EbiPortletModel object specified by ProducerID and PortletName. 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.

Returns:

an EbiPortletModel object.

Since:

v5.0

See Also:

EbiPortletModel

registerPortlet

public EbiPortletRegistration registerPortlet(EbiContext context,
                                              EbiPortletModel pm)
                                       throws EboUnrecoverableSystemException,
                                              EboSecurityException,
                                              com.novell.afw.portlet.api.EboPortletRegistrationDuplicateException,
                                              com.novell.afw.portlet.exception.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.portlet.api.EboPortletRegistrationDuplicateException,
                                              com.novell.afw.portlet.exception.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

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

getUpdateablePortletRegistrationSettings

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

Gets an updateable 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 portletReg,
                                             EbiPortletSettings settings)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Sets the portlet settings for an existing portlet registration in persistence storage. An EbiPortletRegistration object always associated with an EbiPortletSettings object

Parameters:

context - an EbiContext object.

portletReg - an EbiPortletRegistration object to be updated.

settings - a cloned copy of EbiPortletSettingsobject with some modified settings.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletSettings

deregisterPortlet

public void deregisterPortlet(EbiContext context,
                              String portletID)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

De-registers a portlet from a valid portlet producer.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier for the portlet to be deregistered.

Since:

v5.0

getPortletRegistration

public EbiPortletRegistration getPortletRegistration(EbiContext context,
                                                     String portletID)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException,
                                                     com.novell.afw.portlet.api.EboPortletRegistrationException,
                                                     com.novell.afw.portlet.exception.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 EbiPortletRegistration objects for all registered portlets. Only Portal Administrator allows to access this list.

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)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets a list of EbiPortletRegistration objects for all registered portlets.

Parameters:

context - an EbiContext object.

producerID - a producer identifier

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getPortletRegistrationList

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

Gets a list of EbiPortletRegistration objects for all registered portlets that are associated with a specified portlet definition.

Parameters:

context - an EbiContext object.

producerID - a producer identifier

portletName - a portlet name that specifies a particular portlet definition.

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getRestrictedPortletRegistrationList

public Collection getRestrictedPortletRegistrationList(EbiContext context)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets a filtered list of EbiPortletRegistration objects for registered portlets that the authenticated user from EbiContext is allowed to access with LIST permission.

Parameters:

context - an EbiContext object.

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getRestrictedPortletRegistrationList

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

Gets a filtered list of EbiPortletRegistration objects for registered portlets that the authenticated user from EbiContext is allowed to access with the LIST permission.

Parameters:

context - an EbiContext object.

producerID - a producer identifier

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getRestrictedPortletRegistrationListByCategory

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

Gets a filtered list of EbiPortletRegistration objects for registered portlets by category ID that the authenticated user from EbiContext is allowed to access with the LIST permission.

Parameters:

context - an EbiContext object.

categoryID - a portlet category identifier

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getRestrictedPortletRegistrationListByCategory

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

Gets a filtered list of EbiPortletRegistration objects for registered portlets by category ID and producerID that the authenticated user from EbiContext is allowed to access with the LIST permission.

Parameters:

context - an EbiContext object

producerID - a producer identifier

categoryID - a portlet category identifier

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

flushPortletRegistrationSessionCache

public void flushPortletRegistrationSessionCache()
                                          throws EboUnrecoverableSystemException

Flushes session caches for the restricted portlet registration list.

Since:

v5.0

addPortletRegistrationToCategory

public void addPortletRegistrationToCategory(EbiContext context,
                                             String portletID,
                                             String categoryID)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException,
                                             EboItemExistenceException,
                                             com.novell.afw.portlet.api.EboPortletRegistrationException,
                                             com.novell.afw.portlet.exception.EboPortletDefinitionException

Adds a portlet registration to a portlet category.

Parameters:

context - an EbiContext object.

portletID - a portlet ID for a portlet registration.

categoryID - a category indentifier.

Since:

v5.0

removePortletRegistrationFromCategory

public void removePortletRegistrationFromCategory(EbiContext context,
                                                  String portletID,
                                                  String categoryID)
                                           throws EboUnrecoverableSystemException,
                                                  EboSecurityException,
                                                  EboItemExistenceException

Removes a portlet registration from a portlet category.

Parameters:

context - an EbiContext object.

portletID - a portlet ID for a portlet registration.

categoryID - a category indentifier.

Since:

v5.0

See Also:

EbiPortletRegistration

removePortletRegistrationFromCategories

public void removePortletRegistrationFromCategories(EbiContext context,
                                                    String portletID)
                                             throws EboUnrecoverableSystemException,
                                                    EboSecurityException

Removes a portlet registration from all portlet categories.

Parameters:

context - an EbiContext object.

portletID - a portlet ID for a portlet registration.

Since:

v5.0

See Also:

EbiPortletRegistration

getCategoriesByPortletRegistration

public String[] getCategoriesByPortletRegistration(EbiContext context,
                                                   String portletID)
                                            throws EboUnrecoverableSystemException,
                                                   EboSecurityException

Gets a list of portlet categories by a portlet registration.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier.

Returns:

a String Array of portlet category names.

Since:

v5.0

getOrphanPortletRegistrationList

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

Gets a list of orphan portlet registrations that belong to a portlet application that is no longer available from the app/web server.

Parameters:

context - an EbiContext object.

producerID - a producerID for a portlet application.

Returns:

a Collection of EbiPortletRegistrationInfo objects.

Since:

v5.0

cleanOrphanPortletRegistration

public void cleanOrphanPortletRegistration(EbiContext context,
                                           String portletID)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException

Cleans an orphan portlet registration and all related data from persistent store.

Parameters:

context - an EbiContext object.

portletID - a portlet identifier for a portlet registration.

Since:

v5.0

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            EbiPortletRegistration portletReg,
                                            boolean clone)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portlet.api.EboPortletRegistrationException,
                                            com.novell.afw.portlet.exception.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 to clone a new portlet instance and assign a portlet handle or to use the original portlet handle.

Returns:

an EbiPortletEntity object for a newly assigned portlet instance.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletEntity, EbiPortletSettings

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            EbiPortletRegistration portletReg)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portlet.api.EboPortletRegistrationException,
                                            com.novell.afw.portlet.exception.EboPortletDefinitionException

Creates a new portlet instance prepresented by EbiPortletEntity object.

Parameters:

context - an EbiContext object.

portletReg - an EbiPortletRegistration object that represents a portlet registration.

Returns:

an EbiPortletEntity object for a newly assigned portlet instance.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletEntity, EbiPortletSettings

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            EbiPortletRegistration portletReg,
                                            String instanceID)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portlet.api.EboPortletRegistrationException,
                                            com.novell.afw.portlet.exception.EboPortletDefinitionException

Creates a new portlet instance prepresented by EbiPortletEntity object with pre-assigned portlet instance ID.

Parameters:

context - an EbiContext object.

portletReg - an EbiPortletRegistration object that represents a portlet registration.

instanceID - a pre-defined instanceID.

Returns:

an EbiPortletEntity object for a newly assigned portlet instance.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletEntity, EbiPortletSettings

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            String portletID)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portlet.api.EboPortletRegistrationException,
                                            com.novell.afw.portlet.exception.EboPortletDefinitionException

Creates a new portlet instance prepresented by EbiPortletEntity object.

Parameters:

context - an EbiContext object.

portletID - a Portlet identifier.

settings - an EbiPortletSettings object for this portlet instance.

Returns:

an EbiPortletEntity object specified by a portlet ID.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            String portletID,
                                            boolean clone)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portlet.api.EboPortletRegistrationException,
                                            com.novell.afw.portlet.exception.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 to clone a new portlet instance and assign a portlet handle, or to use the original portlet handle.

Returns:

an EbiPortletEntity object specified by a portlet ID.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

createPortletEntity

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

Creates a new portlet instance (a EbiPortletEntity object) with pre-assigned portlet instance ID.

Parameters:

context - an EbiContext object.

portletID - a Portlet identifier.

instanceID - a predefined portlet instance identifier.

Returns:

an EbiPortletEntity object specified by the portletModel object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

clonePortletEntity

public EbiPortletEntity clonePortletEntity(EbiContext context,
                                           EbiPortletEntity entity)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException,
                                           com.novell.afw.portlet.api.EboPortletRegistrationException,
                                           com.novell.afw.portlet.exception.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 cloned EbiPortletEntity object with a newly assigned portlet handle.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

getPortletEntitySettings

public EbiPortletSettings getPortletEntitySettings(EbiContext context,
                                                   EbiPortletEntity entity)
                                            throws EboUnrecoverableSystemException,
                                                   EboSecurityException,
                                                   com.novell.afw.portlet.exception.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

getUpdateablePortletEntitySettings

public EbiPortletSettings getUpdateablePortletEntitySettings(EbiContext context,
                                                             EbiPortletEntity entity)
                                                      throws EboUnrecoverableSystemException,
                                                             EboSecurityException,
                                                             com.novell.afw.portlet.exception.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

storePortletEntitySettings

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

Sets the portlet settings for an existing portlet instance in persistence storage.

Parameters:

context - an EbiContext object.

entity - an existing EbiPortletEntity object.

settings - a cloned copy of EbiPortletSettings object with some modified settings.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

getPortletEntity

public EbiPortletEntity getPortletEntity(EbiContext context,
                                         String instanceID)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException,
                                         com.novell.afw.portlet.api.EboPortletEntityException,
                                         com.novell.afw.portlet.api.EboPortletRegistrationException,
                                         com.novell.afw.portlet.exception.EboPortletDefinitionException

Gets an existing EbiPortletEntity object from the consumer registry.

Parameters:

context - an EbiContext object.

instanceID - a portlet instance identifier.

Returns:

an EbiPortletEntity object specified by the portlet instance identifier.

Since:

v5.0

See Also:

EbiPortletEntity