com.novell.afw.component.api
Interface EbiComponentRegistry

public interface EbiComponentRegistry

The EbiComponentRegistry provides access to information of legacy components that are contained in a resourceset within the associated portal war.

Since:

v5.0

Method Summary

EbiPortletEntity	createPortletEntity(EbiContext context, EbiPortletModel portletModel) Creates a EbiPortletEntity object with newly assigned instance ID for a component specified by the given EbiPortletModel object.
EbiPortletEntity	createPortletEntity(EbiContext context, String componentID) Creates a EbiPortletEntity object with a newly assigned instance identifier for a component specified by the given component ID.
EbiPortletEntity	createPortletEntity(EbiContext context, String componentID, String instanceID) Creates a EbiPortletEntity object from a predefined instance identifier and a component identifier.
Collection	getComponentCategories(EbiContext context) Gets a Collection of EbiCategoryInfo objects for portlet categories.
EbiPortletSettings	getComponentSettings(EbiContext context, EbiPortletEntity entity) Gets Component settings.
EbiPortletSettings	getComponentSettings(EbiContext context, EbiPortletRegistration pr) Gets Component settings.
EbiPortletEntity	getPortletEntity(EbiContext context, String componentID, String componentInstanceID) Gets a EbiPortletEntity object for a specified component instance from the component registry.
EbiPortletModel	getPortletModel(EbiContext context, String componentID) Gets a EbiPortletModel object that contains information of a legacy component which implements EbiPortalComponent.
Collection	getPortletModelList(EbiContext context) Gets a Collection of EbiPortletModel objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war.
EbiPortletRegistration	getPortletRegistration(EbiContext context, String componentID) Gets a EbiPortletRegistration object that contains information of a legacy component which implements EbiPortalComponent.
Collection	getPortletRegistrationList(EbiContext context) Gets a Collection of EbiPortletRegistration objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war.
Collection	getRestrictedPortletModelList(EbiContext context) Gets a Collection of EbiPortletRegistration objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war.
Collection	getRestrictedPortletRegistrationList(EbiContext context) Gets a Collection of EbiPortletRegistration objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war.
Collection	getRestrictedPortletRegistrationListByCategory(EbiContext context, String categoryID) Gets a Collection of EbiPortletRegistration objects for the legacy components that belongs to the specified category ID.
void	init(ServletContext context) Initializes the component registry by loading available portlets from portlet.xml.
void	storeComponentSettings(EbiContext context, EbiPortletEntity entity, EbiPortletSettings settings) Stores Component settings. The component settings are stored in an EbiPortletSettings object which is referenced from the EbiPortletEntity object.

Method Detail

init

public void init(ServletContext context)

Initializes the component registry by loading available portlets from portlet.xml.

Parameters:

context - a ServletContext object.

Since:

v5.0

getPortletModelList

public Collection getPortletModelList(EbiContext context)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Gets a Collection of EbiPortletModel objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war.

Parameters:

context - an EbiContext object

Returns:

a Collection of EbiPortletModel objects.

Since:

v5.0

See Also:

EbiPortletModel

getRestrictedPortletModelList

public Collection getRestrictedPortletModelList(EbiContext context)
                                         throws EboUnrecoverableSystemException,
                                                EboSecurityException

Gets a Collection of EbiPortletRegistration objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war. The returned list only contains the components that the authenticated user (provided from EbiContext) has LIST access right.

Parameters:

context - an EbiContext object

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getPortletModel

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

Gets a EbiPortletModel object that contains information of a legacy component which implements EbiPortalComponent.

Parameters:

context - an EbiContext object

componentID - a component identifier

Returns:

a EbiPortletModel object.

Since:

v5.0

See Also:

EbiPortletModel, EbiPortalComponent

getPortletRegistrationList

public Collection getPortletRegistrationList(EbiContext context)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets a Collection of EbiPortletRegistration objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war.

Parameters:

context - an EbiContext object

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

See Also:

EbiPortletRegistration

getRestrictedPortletRegistrationList

public Collection getRestrictedPortletRegistrationList(EbiContext context)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets a Collection of EbiPortletRegistration objects for the legacy components (that implement EbiPortalComponent) from the resourceset associated in the current portal war. The returned collection only contains the components that the authenticated user has LIST access right.

Parameters:

context - an EbiContext object

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 Collection of EbiPortletRegistration objects for the legacy components that belongs to the specified category ID. The returned collection only contains the components that the authenticated user has LIST access right.

Parameters:

context -

categoryID -

Returns:

a Collection of EbiPortletRegistration objects.

Since:

v5.0

getPortletRegistration

public EbiPortletRegistration getPortletRegistration(EbiContext context,
                                                     String componentID)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException,
                                                     com.novell.afw.portlet.exception.EboPortletDefinitionException

Gets a EbiPortletRegistration object that contains information of a legacy component which implements EbiPortalComponent.

Parameters:

context - an EbiContext object

componentID - a component identifier

Returns:

a EbiPortletRegistration object.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortalComponent

createPortletEntity

public EbiPortletEntity createPortletEntity(EbiContext context,
                                            EbiPortletModel portletModel)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            com.novell.afw.portlet.exception.EboPortletDefinitionException

Creates a EbiPortletEntity object with newly assigned instance ID for a component specified by the given EbiPortletModel object. A EbiPortletEntry object specifies an instance of a legacy component that implements EbiPortalComponent, and contains idenitifiers of that particular component instance.

Parameters:

context - an EbiContext object

portletModel - a EbiPortletModel object that specifies a legacy component

Returns:

a EbiPortletEntity object for the assigned component instance.

Since:

v5.0

See Also:

EbiPortletEntity

createPortletEntity

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

Creates a EbiPortletEntity object with a newly assigned instance identifier for a component specified by the given component ID.
A EbiPortletEntry object specifies an instance of a legacy component that implements EbiPortalComponent, and contains idenitifiers of that particular component instance.

Parameters:

context - an EbiContext object

componentID - a component identifier.

Returns:

a EbiPortletEntity object.

Since:

v5.0

See Also:

EbiPortletEntity

createPortletEntity

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

Creates a EbiPortletEntity object from a predefined instance identifier and a component identifier.
A EbiPortletEntry object specifies an instance of a legacy component that implements EbiPortalComponent, and contains idenitifiers of that particular component instance.

Parameters:

context - an EbiContext object

componentID - a component identifier

instanceID - a predefined component instance identifier

Returns:

a EbiPortletEntity object.

Since:

v5.0

See Also:

EbiPortletEntity

getPortletEntity

public EbiPortletEntity getPortletEntity(EbiContext context,
                                         String componentID,
                                         String componentInstanceID)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException,
                                         com.novell.afw.portlet.exception.EboPortletDefinitionException

Gets a EbiPortletEntity object for a specified component instance from the component registry.
A EbiPortletEntry object specifies an instance of a legacy component that implements EbiPortalComponent, and contains idenitifiers of that particular component instance.

Parameters:

context - an EbiContext object.

componentID - a component identifier.

componentInstanceID - a component instance identifier.

Returns:

a EbiPortletEntity object.

Since:

v5.0

See Also:

EbiPortletEntity

getComponentSettings

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

Gets Component settings.

Parameters:

context - an EbiContext object.

entity - an EbiPortletEntity object.

Returns:

an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

getComponentSettings

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

Gets Component settings.

Parameters:

context - an EbiContext object.

pr - an EbiPortletRegistration object.

Returns:

an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletRegistration, EbiPortletSettings

storeComponentSettings

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

Stores Component settings.
The component settings are stored in an EbiPortletSettings object which is referenced from the EbiPortletEntity object.

Parameters:

context - an EbiContext object.

entity - an EbiPortletEntity object.

settings - an EbiPortletSettings object.

Since:

v5.0

See Also:

EbiPortletEntity, EbiPortletSettings

getComponentCategories

public Collection getComponentCategories(EbiContext context)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException

Gets a Collection of EbiCategoryInfo objects for portlet categories.
The component category definitions are provided from a ReseourceSet.

Parameters:

context -

Returns:

a Collection of EbiCategoryInfo objects.

Since:

v5.0

See Also:

EbiCategoryInfo