org.exoplatform.container
Class ExoContainer

java.lang.Object
  org.exoplatform.container.AbstractContainer
      org.exoplatform.container.ExoContainer

All Implemented Interfaces:

Serializable, Container, Disposable, Startable

Direct Known Subclasses:

PortalContainer, RootContainer, StandaloneContainer

public class ExoContainer
extends AbstractContainer

Created by The eXo Platform SAS
The Exo Container is an object responsible for loading services/components. The eXoContainer class is inherited by all the containers, including RootContainer, PortalContainer, and StandaloneContainer. It itself inherits from a Container which allows eXo to apply the Inversion of Control (also known as IoC) principles.

Author:

Tuan Nguyen

See Also:

Serialized Form

Field Summary

protected ExoContainerContext	context
protected static Log	LOG
protected ExoContainer	parent
protected AtomicBoolean	stopping

Fields inherited from class org.exoplatform.container.AbstractContainer

delegate

Constructor Summary

ExoContainer()

ExoContainer(ExoContainer parent)

Method Summary

void	addComponentLifecylePlugin(ComponentLifecyclePlugin plugin)
void	addContainerLifecylePlugin(ContainerLifecyclePlugin plugin)
boolean	canBeDisposed() Indicates whether or not the container can be disposed
protected boolean	canBeInitialized() Indicates whether or not the container can be initialized
boolean	canBeStarted() Indicates whether or not the container can be started
boolean	canBeStopped() Indicates whether or not the container can be stopped
<T> T	createComponent(Class<T> clazz) Creates a component corresponding to the given Class with no parameters This is equivalent to call AbstractContainer.createComponent(Class, InitParams) with null as InitParams
void	dispose() Dispose this component.
ComponentAdapter<?>	getComponentAdapter(Object componentKey) Find a component adapter associated with the specified key.
Object	getComponentInstance(Object componentKey) Retrieve a component instance registered with a specific key.
protected Configuration	getConfiguration() Gets the ConfigurationManager from the given ExoContainer if it exists, then returns the nested Configuration otherwise it returns null
ExoContainerContext	getContext()
ExoContainer	getParent() Gives the parent container of this container.
static Set<String>	getProfiles() Returns an unmodifiable set of profiles defined by the value returned by invoking PropertyManager.getProperty(String) with the PropertyManager.RUNTIME_PROFILES property.
Set<String>	getRegisteredComponentNames()
static boolean	hasProfile(String profileName) Indicates whether or not a given profile exists
void	initialize() Initializes the container
<T> ComponentAdapter<T>	registerComponentImplementation(Class<T> componentImplementation) Register a component using the componentImplementation as key.
<T> ComponentAdapter<T>	registerComponentInstance(T componentInstance) Register an arbitrary object.
void	start() Start this component.
void	start(boolean init) Starts the container
void	stop() Stop this component.
protected void	unregisterAllComponents() Unregister all components from container to avoid keeping instances in memory.

Methods inherited from class org.exoplatform.container.AbstractContainer

accept, createComponent, getComponentAdapter, getComponentAdapterOfType, getComponentAdapters, getComponentAdaptersOfType, getComponentInstance, getComponentInstanceOfType, getComponentInstancesOfType, getManagementContext, getMBeanServer, getScopingObjectName, getSuccessor, registerComponentImplementation, registerComponentInstance, unregisterComponent

Methods inherited from class java.lang.Object

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

Field Detail

stopping

protected final AtomicBoolean stopping

LOG

protected static final Log LOG

context

protected final ExoContainerContext context

parent

protected final ExoContainer parent

Constructor Detail

ExoContainer

public ExoContainer()

ExoContainer

public ExoContainer(ExoContainer parent)

Method Detail

getProfiles

public static Set<String> getProfiles()

Returns an unmodifiable set of profiles defined by the value returned by invoking PropertyManager.getProperty(String) with the PropertyManager.RUNTIME_PROFILES property.

Returns:

the set of profiles

hasProfile

public static boolean hasProfile(String profileName)

Indicates whether or not a given profile exists

Parameters:

profileName - the name of the profile to check

Returns:

true if the profile exists, false otherwise.

getContext

public ExoContainerContext getContext()

dispose

public void dispose()

Description copied from class: AbstractContainer

Dispose this component. The component should deallocate all resources. The contract for this method defines a single call at the end of this component's life.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class AbstractContainer

start

public void start(boolean init)

Starts the container

Parameters:

init - indicates if the container must be initialized first

initialize

public void initialize()

Description copied from class: AbstractContainer

Initializes the container

Specified by:

initialize in interface Container

Overrides:

initialize in class AbstractContainer

start

public void start()

Description copied from class: AbstractContainer

Start this component. Called initially at the begin of the lifecycle. It can be called again after a stop.

Specified by:

start in interface Startable

Overrides:

start in class AbstractContainer

stop

public void stop()

Description copied from class: AbstractContainer

Stop this component. Called near the end of the lifecycle. It can be called again after a further start. Implement Disposable if you need a single call at the definite end of the lifecycle.

Specified by:

stop in interface Startable

Overrides:

stop in class AbstractContainer

addComponentLifecylePlugin

public void addComponentLifecylePlugin(ComponentLifecyclePlugin plugin)

addContainerLifecylePlugin

public void addContainerLifecylePlugin(ContainerLifecyclePlugin plugin)

getConfiguration

protected Configuration getConfiguration()

Gets the ConfigurationManager from the given ExoContainer if it exists, then returns the nested Configuration otherwise it returns null

unregisterAllComponents

protected void unregisterAllComponents()

Unregister all components from container to avoid keeping instances in memory.

registerComponentImplementation

public <T> ComponentAdapter<T> registerComponentImplementation(Class<T> componentImplementation)
                                                    throws ContainerException

Register a component using the componentImplementation as key. Calling this method is equivalent to calling registerComponentImplementation(componentImplementation, componentImplementation).

Parameters:

componentImplementation - the concrete component class.

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the Container interface can be used to retrieve a reference to the component later on.

Throws:

ContainerException - if registration fails.

registerComponentInstance

public <T> ComponentAdapter<T> registerComponentInstance(T componentInstance)
                                              throws ContainerException

Register an arbitrary object. The class of the object will be used as a key. Calling this method is equivalent to calling * registerComponentImplementation(componentImplementation, componentImplementation).

Parameters:

componentInstance -

Returns:

the ComponentAdapter that has been associated with this component. In the majority of cases, this return value can be safely ignored, as one of the getXXX() methods of the Container interface can be used to retrieve a reference to the component later on.

Throws:

ContainerException - if registration fails.

createComponent

public <T> T createComponent(Class<T> clazz)
                  throws Exception

Creates a component corresponding to the given Class with no parameters This is equivalent to call AbstractContainer.createComponent(Class, InitParams) with null as InitParams

Parameters:

clazz - the Class of the object to create

Returns:

an instance of the component

Throws:

Exception - if any issue occurs while creating the component.

getComponentAdapter

public ComponentAdapter<?> getComponentAdapter(Object componentKey)

Find a component adapter associated with the specified key. If a component adapter cannot be found in this container, the parent container (if one exists) will be searched.

Parameters:

componentKey - the key that the component was registered with.

Returns:

the component adapter associated with this key, or null if no component has been registered for the specified key.

getComponentInstance

public Object getComponentInstance(Object componentKey)

Retrieve a component instance registered with a specific key. If a component cannot be found in this container, the parent container (if one exists) will be searched.

Parameters:

componentKey - the key that the component was registered with.

Returns:

an instantiated component, or null if no component has been registered for the specified key.

getRegisteredComponentNames

public Set<String> getRegisteredComponentNames()
                                        throws ContainerException

Throws:

ContainerException

getParent

public ExoContainer getParent()

Gives the parent container of this container.

Returns:

a ExoContainer instance, or null if this container does not have a parent.

canBeStarted

public boolean canBeStarted()

Indicates whether or not the container can be started

Returns:

true if it can be started, false otherwise.

canBeStopped

public boolean canBeStopped()

Indicates whether or not the container can be stopped

Returns:

true if it can be stopped, false otherwise.

canBeDisposed

public boolean canBeDisposed()

Indicates whether or not the container can be disposed

Returns:

true if it can be disposed, false otherwise.

canBeInitialized

protected boolean canBeInitialized()

Indicates whether or not the container can be initialized

Returns:

true if it can be initialized, false otherwise.