Package org.hippoecm.hst.core.container

Interface HstComponentFactory

public interface HstComponentFactory

The factory interface which is responsible for creating HstComponent instances.

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
HstComponent	getComponentInstance(HstContainerConfig requestContainerConfig, HstComponentConfiguration compConfig, Mount mount)	Returns the HstComponent instance from the HstComponent context.
HstComponentMetadata	getComponentMetadata(HstContainerConfig requestContainerConfig, HstComponentConfiguration compConfig, Mount mount)	Returns the metadata of the HstComponent from the HstComponent context.
String	getDefaultHstComponentClassName()	Returns the default HST Component class name
<T> T	getObjectInstance(HstContainerConfig requestContainerConfig, String className)	Returns arbitrary object instance from the HstComponent context.

Method Detail

getComponentInstance

HstComponent getComponentInstance(HstContainerConfig requestContainerConfig,
                                  HstComponentConfiguration compConfig,
                                  Mount mount)
                           throws HstComponentException

Returns the HstComponent instance from the HstComponent context.

Parameters:

requestContainerConfig - the HstContainer configuration

compConfig - the HstComponent configuration

mount - the Mount to create the component instance for

Returns:

the instance of the HstComponent

Throws:

HstComponentException

getComponentMetadata

HstComponentMetadata getComponentMetadata(HstContainerConfig requestContainerConfig,
                                          HstComponentConfiguration compConfig,
                                          Mount mount)
                                   throws HstComponentException

Returns the metadata of the HstComponent from the HstComponent context.

Parameters:

requestContainerConfig - the HstContainer configuration

compConfig - the HstComponent configuration

mount - the Mount to create the component instance for

Returns:

the metadata of the HstComponent

Throws:

HstComponentException

getObjectInstance

<T> T getObjectInstance(HstContainerConfig requestContainerConfig,
                        String className)
                 throws HstComponentException

Returns arbitrary object instance from the HstComponent context.

Type Parameters:

T -

Parameters:

requestContainerConfig -

className -

Throws:

HstComponentException

getDefaultHstComponentClassName

String getDefaultHstComponentClassName()

Returns the default HST Component class name