This project has retired. For details please refer to its Attic page.

org.apache.cocoon.components
Class LifecycleHelper

java.lang.Object
  org.apache.cocoon.components.LifecycleHelper

public class LifecycleHelper

extends Object

Utility class for setting up Avalon components. Similar to Excalibur's DefaultComponentFactory, but on existing objects.

Version:

$Id: LifecycleHelper.html 1304280 2012-03-23 11:18:01Z ilgrosso $

Constructor Summary

LifecycleHelper(Logger logger, Context context, ServiceManager serviceManager, Configuration configuration)
Deprecated. Construct a new LifecycleHelper that can be used repeatedly to setup several components.

Method Summary

static void	decommission(Object component) Deprecated. Decomission a component, by stopping (if it's Startable) and disposing (if it's Disposable) a component.
static void	dispose(Object component) Deprecated. Dispose a component if it's Disposable.
Object	setupComponent(Object component) Deprecated. Setup a component, including initialization and start.
Object	setupComponent(Object component, boolean initializeAndStart) Deprecated. Setup a component, and optionnaly initializes (if it's Initializable) and starts it (if it's Startable).
static Object	setupComponent(Object component, Log logger, Context context, ServiceManager serviceManager, Configuration configuration) Deprecated. Alternative setupComponent method that uses Commons Logging logger.
static Object	setupComponent(Object component, Log logger, Context context, ServiceManager manager, Configuration configuration, boolean initializeAndStart) Deprecated. Alternative setupComponent method that uses Commons Logging logger.
static Object	setupComponent(Object component, Logger logger, Context context, ServiceManager serviceManager, Configuration configuration) Deprecated.
static Object	setupComponent(Object component, Logger logger, Context context, ServiceManager serviceManager, Configuration configuration, boolean initializeAndStart) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

LifecycleHelper

public LifecycleHelper(Logger logger,
                       Context context,
                       ServiceManager serviceManager,
                       Configuration configuration)

Deprecated.

Construct a new LifecycleHelper that can be used repeatedly to setup several components.

Note : if a parameter is null, the corresponding method isn't called (e.g. if configuration is null, configure() isn't called).

Parameters:

logger - the Logger to pass to LogEnableds, unless there is a LogKitManager and the configuration specifies a logger name.

context - the Context to pass to Contexutalizables.

serviceManager - the service manager to pass to Serviceables.

configuration - the Configuration object to pass to new instances.

Method Detail

setupComponent

public Object setupComponent(Object component)
                      throws Exception

Deprecated.

Setup a component, including initialization and start.

Parameters:

component - the component to setup.

Returns:

the component passed in, to allow function chaining.

Throws:

Exception - if something went wrong.

setupComponent

public Object setupComponent(Object component,
                             boolean initializeAndStart)
                      throws Exception

Deprecated.

Setup a component, and optionnaly initializes (if it's Initializable) and starts it (if it's Startable).

Parameters:

component - the component to setup.

initializeAndStart - if true, intialize() and start() will be called.

Returns:

the component passed in, to allow function chaining.

Throws:

Exception - if something went wrong.

setupComponent

public static Object setupComponent(Object component,
                                    Logger logger,
                                    Context context,
                                    ServiceManager serviceManager,
                                    Configuration configuration)
                             throws Exception

Deprecated.

Throws:

Exception

setupComponent

public static Object setupComponent(Object component,
                                    Log logger,
                                    Context context,
                                    ServiceManager serviceManager,
                                    Configuration configuration)
                             throws Exception

Deprecated.

Alternative setupComponent method that uses Commons Logging logger.

Throws:

Exception

setupComponent

public static Object setupComponent(Object component,
                                    Logger logger,
                                    Context context,
                                    ServiceManager serviceManager,
                                    Configuration configuration,
                                    boolean initializeAndStart)
                             throws Exception

Deprecated.

Throws:

Exception

setupComponent

public static Object setupComponent(Object component,
                                    Log logger,
                                    Context context,
                                    ServiceManager manager,
                                    Configuration configuration,
                                    boolean initializeAndStart)
                             throws Exception

Deprecated.

Alternative setupComponent method that uses Commons Logging logger.

Throws:

Exception

decommission

public static void decommission(Object component)
                         throws Exception

Deprecated.

Decomission a component, by stopping (if it's Startable) and disposing (if it's Disposable) a component.

Throws:

Exception

dispose

public static void dispose(Object component)

Deprecated.

Dispose a component if it's Disposable. Otherwhise, do nothing.