org.hippoecm.hst.core.container

Interface HstComponentRegistry

public interface HstComponentRegistry

The HstComponent registry interface

Method Summary

Modifier and Type	Method and Description
HstComponent	getComponent(HstContainerConfig requestContainerConfig, String componentId) Returns the registered HstComponent.
HstComponentMetadata	getComponentMetadata(HstContainerConfig requestContainerConfig, String componentId) Returns the metadata of the registered HstComponent.
void	registerComponent(HstContainerConfig requestContainerConfig, String componentId, HstComponent component) Registers the HstComponent.
void	unregisterAllComponents() Unregisters all the HstComponents.
void	unregisterComponent(HstContainerConfig requestContainerConfig, String componentId) Unregister the HstComponent.

Method Detail

registerComponent

void registerComponent(HstContainerConfig requestContainerConfig,
                       String componentId,
                       HstComponent component)

Registers the HstComponent. The key is the pair of container configuration and component ID.

Parameters:

requestContainerConfig - the container configuration

componentId - the component ID

component -

unregisterComponent

void unregisterComponent(HstContainerConfig requestContainerConfig,
                         String componentId)

Unregister the HstComponent. The key is the pair of container configuration and component ID.

Parameters:

requestContainerConfig - the container configuration

componentId - the component ID

getComponent

HstComponent getComponent(HstContainerConfig requestContainerConfig,
                          String componentId)

Returns the registered HstComponent. The key is the pair of container configuration and component ID.

If the component is not found, then it will return null.

Parameters:

requestContainerConfig - the container configuration

componentId - the component ID

Returns:

the HstComponent registered with the key pair.

getComponentMetadata

HstComponentMetadata getComponentMetadata(HstContainerConfig requestContainerConfig,
                                          String componentId)

Returns the metadata of the registered HstComponent. The key is the pair of container configuration and component ID.

If the component metadata is not found, then it will return null.

Parameters:

requestContainerConfig - the container configuration

componentId - the component ID

Returns:

the metadata of the HstComponent registered with the key pair.

unregisterAllComponents

void unregisterAllComponents()

Unregisters all the HstComponents.