org.hippoecm.hst.mock.core.container

Class MockComponentManager

java.lang.Object

org.hippoecm.hst.mock.core.container.MockComponentManager

All Implemented Interfaces:

ComponentManager

public class MockComponentManager
extends Object
implements ComponentManager

Constructor Summary

Constructors

Constructor and Description
MockComponentManager()

Method Summary

Modifier and Type	Method and Description
<T> void	addComponent(String name, T component)
void	close() Closes the component manager and all the components.
<T> T	getComponent(Class<T> requiredType) Returns the registered container component by the specified type if any.
<T> T	getComponent(Class<T> requiredType, String... addonModuleNames) Returns the registered component from a child context by the specified type.
<T> T	getComponent(String name) Returns the registered container component by name.
<T> T	getComponent(String name, String... addonModuleNames) Returns the registered component from a child context.
<T> Map<String,T>	getComponentsOfType(Class<T> requiredType) Returns the registered container components that match the given object type (including subclasses).
<T> Map<String,T>	getComponentsOfType(Class<T> requiredType, String... addonModuleNames) Returns the registered container component that match the given object type (including subclasses) from a child context.
String[]	getConfigurationResources() Returns configuration resources for components assembly
ContainerConfiguration	getContainerConfiguration() Returns the container configuration
javax.servlet.ServletConfig	getServletConfig() Deprecated. deprecated since since 3.2.0
javax.servlet.ServletContext	getServletContext()
void	initialize() Initializes the component manager and container components.
void	publishEvent(EventObject event) Publish the given event to all components which wants to listen to.
void	registerEventSubscriber(Object subscriber) Registers event subscriber object to receive events.
void	setConfigurationResources(String[] configurationResources) Sets configuration resources for components assembly
void	setServletConfig(javax.servlet.ServletConfig servletConfig) Deprecated. deprecated since since 3.2.0
void	setServletContext(javax.servlet.ServletContext servletContext) Set the ServletContext that this object runs in.
void	start() Starts the component manager to serve container components.
void	stop() Stop the component manager.
void	unregisterEventSubscriber(Object subscriber) Unregisters event subscriber object.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockComponentManager

public MockComponentManager()

Method Detail

setConfigurationResources

public void setConfigurationResources(String[] configurationResources)

Description copied from interface: ComponentManager

Sets configuration resources for components assembly

Specified by:

setConfigurationResources in interface ComponentManager

getConfigurationResources

public String[] getConfigurationResources()

Description copied from interface: ComponentManager

Returns configuration resources for components assembly

Specified by:

getConfigurationResources in interface ComponentManager

setServletConfig

@Deprecated
public void setServletConfig(javax.servlet.ServletConfig servletConfig)

Deprecated. deprecated since since 3.2.0

Description copied from interface: ComponentManager

Set the ServletConfig that this object runs in.

Specified by:

setServletConfig in interface ComponentManager

See Also:

ComponentManager.setServletConfig(javax.servlet.ServletConfig)

getServletConfig

@Deprecated
public javax.servlet.ServletConfig getServletConfig()

Deprecated. deprecated since since 3.2.0

Description copied from interface: ComponentManager

Returns the ServletConfig that this object runs in if available. Otherwise returns null.

Specified by:

getServletConfig in interface ComponentManager

Returns:

the ServletConfig that this object runs in, otherwise null

See Also:

ComponentManager.getServletConfig()

setServletContext

public void setServletContext(javax.servlet.ServletContext servletContext)

Description copied from interface: ComponentManager

Set the ServletContext that this object runs in.

Specified by:

setServletContext in interface ComponentManager

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface ComponentManager

Returns:

the ServletContext that this object runs in

initialize

public void initialize()

Description copied from interface: ComponentManager

Initializes the component manager and container components.

Specified by:

initialize in interface ComponentManager

start

public void start()

Description copied from interface: ComponentManager

Starts the component manager to serve container components.

Specified by:

start in interface ComponentManager

getComponent

public <T> T getComponent(String name)

Description copied from interface: ComponentManager

Returns the registered container component by name. Returns null if a component is not found by the specified name.

Specified by:

getComponent in interface ComponentManager

Type Parameters:

T - component type

Parameters:

name - the name of the component

Returns:

component

getComponent

public <T> T getComponent(Class<T> requiredType)
                   throws ComponentsException

Description copied from interface: ComponentManager

Returns the registered container component by the specified type if any. Implementation may also look up a component by translating the specified type into a conventional FQCN string of the type if a component is not found by the specified type. Returns null if no component is found. If there is not exactly single matching component found by the specified type, then it throws a ComponentsException.

Specified by:

getComponent in interface ComponentManager

Parameters:

requiredType - type the bean must match; can be an interface or superclass.

Returns:

component matching the required type or null if not found by the specified type

Throws:

ComponentsException

getComponentsOfType

public <T> Map<String,T> getComponentsOfType(Class<T> requiredType)

Description copied from interface: ComponentManager

Returns the registered container components that match the given object type (including subclasses). Returns empty map if a component is not found by the specified required type.

Specified by:

getComponentsOfType in interface ComponentManager

Type Parameters:

T - component type

Parameters:

requiredType - the required type of the component

Returns:

component map

getComponent

public <T> T getComponent(String name,
                          String... addonModuleNames)

Description copied from interface: ComponentManager

Returns the registered component from a child context. If addonModuleNames consists of multiple items, then each addonModuleNames item is regarded as child addon module name in the descendant hierarchy, as ordered. Returns null if a component is not found by the specified name.

Specified by:

getComponent in interface ComponentManager

getComponent

public <T> T getComponent(Class<T> requiredType,
                          String... addonModuleNames)

Description copied from interface: ComponentManager

Returns the registered component from a child context by the specified type. Implementation may also look up a component by translating the specified type into a conventional FQCN string of the type if a component is not found by the specified type. Returns null if no component is found. If there is not exactly single matching component found by the specified type, then it throws a ComponentsException. If addonModuleNames consists of multiple items, then each addonModuleNames item is regarded as child addon module name in the descendant hierarchy, as ordered.

Specified by:

getComponent in interface ComponentManager

Parameters:

requiredType - type the bean must match; can be an interface or superclass.

Returns:

component matching the required type or null if not found by the specified type

getComponentsOfType

public <T> Map<String,T> getComponentsOfType(Class<T> requiredType,
                                             String... addonModuleNames)

Description copied from interface: ComponentManager

Returns the registered container component that match the given object type (including subclasses) from a child context. Returns empty map if a component is not found from a child context by the specified required type. If addonModuleNames consists of multiple items, then each addonModuleNames item is regarded as child addon module name in the descendant hierarchy, as ordered. Returns empty map if a component is not found by the specified type.

Specified by:

getComponentsOfType in interface ComponentManager

Returns:

component map

publishEvent

public void publishEvent(EventObject event)

Description copied from interface: ComponentManager

Publish the given event to all components which wants to listen to.

Specified by:

publishEvent in interface ComponentManager

Parameters:

event - the event to publish (may be an application-specific or built-in HST-2 event)

registerEventSubscriber

public void registerEventSubscriber(Object subscriber)

Description copied from interface: ComponentManager

Registers event subscriber object to receive events.

Specified by:

registerEventSubscriber in interface ComponentManager

unregisterEventSubscriber

public void unregisterEventSubscriber(Object subscriber)

Description copied from interface: ComponentManager

Unregisters event subscriber object.

Specified by:

unregisterEventSubscriber in interface ComponentManager

stop

public void stop()

Description copied from interface: ComponentManager

Stop the component manager.

Specified by:

stop in interface ComponentManager

close

public void close()

Description copied from interface: ComponentManager

Closes the component manager and all the components.

Specified by:

close in interface ComponentManager

getContainerConfiguration

public ContainerConfiguration getContainerConfiguration()

Description copied from interface: ComponentManager

Returns the container configuration

Specified by:

getContainerConfiguration in interface ComponentManager

Returns:

the container configuration

addComponent

public <T> void addComponent(String name,
                             T component)