org.apache.avalon.excalibur.component
Class DefaultComponentHandler

java.lang.Object
  extended by org.apache.avalon.framework.logger.AbstractLogEnabled
      extended by org.apache.avalon.excalibur.component.AbstractDualLogEnabled
          extended by org.apache.avalon.excalibur.component.AbstractDualLogEnabledInstrumentable
              extended by org.apache.avalon.excalibur.component.ComponentHandler
                  extended by org.apache.avalon.excalibur.component.DefaultComponentHandler
All Implemented Interfaces:
org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.logger.Loggable, org.apache.excalibur.instrument.Instrumentable

Deprecated. ECM is no longer supported

public class DefaultComponentHandler
extends ComponentHandler

The DefaultComponentHandler to make sure components are initialized and destroyed correctly.

Since:
4.0
Version:
CVS $Revision: 1.4 $ $Date: 2004/02/28 11:47:14 $
Author:
Avalon Development Team

Field Summary
private  boolean m_disposed
          Deprecated. State management boolean stating whether the Handler is disposed or not
private  DefaultComponentFactory m_factory
          Deprecated. The instance of the ComponentFactory that creates and disposes of the Component
private  boolean m_initialized
          Deprecated. State management boolean stating whether the Handler is initialized or not
 
Fields inherited from interface org.apache.excalibur.instrument.Instrumentable
EMPTY_INSTRUMENT_ARRAY, EMPTY_INSTRUMENTABLE_ARRAY
 
Constructor Summary
  DefaultComponentHandler(DefaultComponentFactory factory, org.apache.avalon.framework.configuration.Configuration config)
          Deprecated. Create a DefaultComponentHandler which manages a pool of Components created by the specified factory object.
protected DefaultComponentHandler(java.lang.String role, java.lang.Class componentClass, org.apache.avalon.framework.configuration.Configuration config, org.apache.avalon.framework.component.ComponentManager manager, org.apache.avalon.framework.context.Context context, RoleManager roles, LogkitLoggerManager logkit)
          Deprecated. Create a ComponentHandler that takes care of hiding the details of whether a Component is ThreadSafe, Poolable, or SingleThreaded.
 
Method Summary
 void dispose()
          Deprecated. Dispose of the ComponentHandler and any associated Pools and Factories.
protected  org.apache.avalon.framework.component.Component doGet()
          Deprecated. Get a reference of the desired Component
protected  void doPut(org.apache.avalon.framework.component.Component component)
          Deprecated. Return a reference of the desired Component
 void initialize()
          Deprecated. Initialize the ComponentHandler.
 
Methods inherited from class org.apache.avalon.excalibur.component.ComponentHandler
canBeDisposed, get, getComponentHandler, getComponentHandler, getComponentHandler, getComponentHandler, getComponentHandler, put
 
Methods inherited from class org.apache.avalon.excalibur.component.AbstractDualLogEnabledInstrumentable
addChildInstrumentable, addInstrument, getChildInstrumentables, getInstrumentableName, getInstruments, setInstrumentableName
 
Methods inherited from class org.apache.avalon.excalibur.component.AbstractDualLogEnabled
getLogkitLogger, setLogger
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_factory

private final DefaultComponentFactory m_factory
Deprecated. 
The instance of the ComponentFactory that creates and disposes of the Component


m_initialized

private boolean m_initialized
Deprecated. 
State management boolean stating whether the Handler is initialized or not


m_disposed

private boolean m_disposed
Deprecated. 
State management boolean stating whether the Handler is disposed or not

Constructor Detail

DefaultComponentHandler

protected DefaultComponentHandler(java.lang.String role,
                                  java.lang.Class componentClass,
                                  org.apache.avalon.framework.configuration.Configuration config,
                                  org.apache.avalon.framework.component.ComponentManager manager,
                                  org.apache.avalon.framework.context.Context context,
                                  RoleManager roles,
                                  LogkitLoggerManager logkit)
                           throws java.lang.Exception
Deprecated. 
Create a ComponentHandler that takes care of hiding the details of whether a Component is ThreadSafe, Poolable, or SingleThreaded. It falls back to SingleThreaded if not specified.

Parameters:
componentClass - Class of the component of the handler being created.
config - The configuration for the component.
manager - The ComponentManager which will be managing the Component.
context - The current context.
roles - The current RoleManager.
logkit - The current LogKitLoggerManager.
Throws:
java.lang.Exception - If there are any problems creating the handler.

DefaultComponentHandler

public DefaultComponentHandler(DefaultComponentFactory factory,
                               org.apache.avalon.framework.configuration.Configuration config)
                        throws java.lang.Exception
Deprecated. 
Create a DefaultComponentHandler which manages a pool of Components created by the specified factory object.

Parameters:
factory - The factory object which is responsible for creating the components managed by the ComponentHandler.
config - The configuration to use to configure the pool.
Throws:
java.lang.Exception - If there are any problems creating the handler.
Method Detail

initialize

public void initialize()
Deprecated. 
Initialize the ComponentHandler.


doGet

protected org.apache.avalon.framework.component.Component doGet()
                                                         throws java.lang.Exception
Deprecated. 
Get a reference of the desired Component

Overrides:
doGet in class ComponentHandler
Returns:
A component instance.
Throws:
java.lang.Exception - If there are any problems encountered acquiring a component instance.

doPut

protected void doPut(org.apache.avalon.framework.component.Component component)
Deprecated. 
Return a reference of the desired Component

Overrides:
doPut in class ComponentHandler
Parameters:
component - Component to be be put/released back to the handler.

dispose

public void dispose()
Deprecated. 
Dispose of the ComponentHandler and any associated Pools and Factories.