org.apache.avalon.excalibur.component

Class ExcaliburComponentManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.avalon.excalibur.component.AbstractDualLogEnabled

org.apache.avalon.excalibur.component.ExcaliburComponentManager

All Implemented Interfaces:

RoleManageable, org.apache.avalon.excalibur.logger.LoggerManageable, org.apache.avalon.excalibur.logger.LogKitManageable, org.apache.avalon.framework.activity.Disposable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.component.ComponentManager, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.logger.Loggable, org.apache.excalibur.instrument.Instrumentable, org.apache.excalibur.instrument.InstrumentManageable

Direct Known Subclasses:

DefaultComponentManager

Deprecated.

ECM is no longer supported

public class ExcaliburComponentManager
extends AbstractDualLogEnabled
implements org.apache.avalon.framework.component.ComponentManager, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.context.Contextualizable, org.apache.avalon.framework.activity.Initializable, org.apache.avalon.framework.activity.Disposable, RoleManageable, org.apache.avalon.excalibur.logger.LogKitManageable, org.apache.avalon.excalibur.logger.LoggerManageable, org.apache.excalibur.instrument.InstrumentManageable, org.apache.excalibur.instrument.Instrumentable

Default component manager for Avalon's components.

Since:

4.0

Version:

CVS $Revision: 1.6 $ $Date: 2004/02/28 11:47:14 $

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	INSTRUMENTABLE_NAME Deprecated. Instrumentable name used to represent the component-manager.
private java.util.Map	m_componentHandlers Deprecated. Used to map roles to ComponentHandlers.
private java.util.Map	m_componentMapping Deprecated. Static component mapping handlers.
private org.apache.avalon.framework.context.Context	m_context Deprecated. The application context for components
private boolean	m_disposed Deprecated. Is the Manager disposed or not?
private boolean	m_initialized Deprecated. Is the Manager initialized?
private java.lang.String	m_instrumentableName Deprecated. Instrumentable Name assigned to this Instrumentable
private org.apache.excalibur.instrument.InstrumentManager	m_instrumentManager Deprecated. Instrument Manager being used by the Component Manager.
private java.lang.ClassLoader	m_loader Deprecated. The classloader used for this system.
private LogkitLoggerManager	m_logkit Deprecated. LogKitManager.
private java.util.List	m_newComponentHandlers Deprecated. added component handlers before initialization to maintain the order of initialization
private org.apache.avalon.framework.component.ComponentManager	m_parentManager Deprecated. The parent ComponentLocator
private RoleManager	m_roles Deprecated. RoleInfos.

Fields inherited from interface org.apache.excalibur.instrument.Instrumentable

EMPTY_INSTRUMENT_ARRAY, EMPTY_INSTRUMENTABLE_ARRAY

Constructor Summary

Constructors

Constructor and Description
ExcaliburComponentManager() Deprecated. Create a new ExcaliburComponentManager.
ExcaliburComponentManager(java.lang.ClassLoader loader) Deprecated. Create a new ExcaliburComponentManager with uses a specific Classloader.
ExcaliburComponentManager(org.apache.avalon.framework.component.ComponentManager manager) Deprecated. Create the ComponentLocator with a parent ComponentLocator
ExcaliburComponentManager(org.apache.avalon.framework.component.ComponentManager manager, java.lang.ClassLoader loader) Deprecated. Create the ComponentLocator with a Classloader and parent ComponentLocator

Method Summary

Methods

Modifier and Type	Method and Description
void	addComponent(java.lang.String role, java.lang.Class component, org.apache.avalon.framework.configuration.Configuration configuration) Deprecated. Add a new component to the manager.
void	addComponentInstance(java.lang.String role, org.apache.avalon.framework.component.Component instance) Deprecated. Add a static instance of a component to the manager.
void	configure(org.apache.avalon.framework.configuration.Configuration configuration) Deprecated. Configure the ComponentLocator.
void	contextualize(org.apache.avalon.framework.context.Context context) Deprecated. Set up the Component's Context.
void	dispose() Deprecated. Properly dispose of the Child handlers.
org.apache.excalibur.instrument.Instrumentable[]	getChildInstrumentables() Deprecated. Any Object which implements Instrumentable can also make use of other Instrumentable child objects.
protected ComponentHandler	getComponentHandler(java.lang.String role, java.lang.Class componentClass, org.apache.avalon.framework.configuration.Configuration configuration, org.apache.avalon.framework.context.Context context, RoleManager roleManager, LogkitLoggerManager logkitManager) Deprecated. Obtain a new ComponentHandler for the specified component.
java.lang.String	getInstrumentableName() Deprecated. Gets the name of the Instrumentable.
org.apache.excalibur.instrument.Instrument[]	getInstruments() Deprecated. Obtain a reference to all the Instruments that the Instrumentable object wishes to expose.
boolean	hasComponent(java.lang.String role) Deprecated. Tests for existence of a component.
void	initialize() Deprecated. Properly initialize of the Child handlers.
org.apache.avalon.framework.component.Component	lookup(java.lang.String role) Deprecated. Return an instance of a component based on a Role.
void	release(org.apache.avalon.framework.component.Component component) Deprecated. Release a Component.
private void	removeDisposedHandlers(java.util.List disposed) Deprecated.
void	setInstrumentableName(java.lang.String name) Deprecated. Sets the name for the Instrumentable.
void	setInstrumentManager(org.apache.excalibur.instrument.InstrumentManager instrumentManager) Deprecated. Sets the InstrumentManager for child components.
void	setLoggerManager(org.apache.avalon.excalibur.logger.LoggerManager logkit) Deprecated. Configure the LoggerManager.
void	setLogKitManager(org.apache.avalon.excalibur.logger.LogKitManager logkit) Deprecated. Configure the LogKitManager
void	setRoleManager(RoleManager roles) Deprecated. Configure the RoleManager

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

INSTRUMENTABLE_NAME

public static final java.lang.String INSTRUMENTABLE_NAME

Deprecated.

Instrumentable name used to represent the component-manager. Handlers reference this name to register themselves at the correct location under the ECM.

See Also:

Constant Field Values

m_parentManager

private final org.apache.avalon.framework.component.ComponentManager m_parentManager

Deprecated.

The parent ComponentLocator

m_loader

private final java.lang.ClassLoader m_loader

Deprecated.

The classloader used for this system.

m_context

private org.apache.avalon.framework.context.Context m_context

Deprecated.

The application context for components

m_componentMapping

private final java.util.Map m_componentMapping

Deprecated.

Static component mapping handlers.

m_componentHandlers

private final java.util.Map m_componentHandlers

Deprecated.

Used to map roles to ComponentHandlers.

m_newComponentHandlers

private final java.util.List m_newComponentHandlers

Deprecated.

added component handlers before initialization to maintain the order of initialization

m_roles

private RoleManager m_roles

Deprecated.

RoleInfos.

m_logkit

private LogkitLoggerManager m_logkit

Deprecated.

LogKitManager.

m_disposed

private boolean m_disposed

Deprecated.

Is the Manager disposed or not?

m_initialized

private boolean m_initialized

Deprecated.

Is the Manager initialized?

m_instrumentManager

private org.apache.excalibur.instrument.InstrumentManager m_instrumentManager

Deprecated.

Instrument Manager being used by the Component Manager.

m_instrumentableName

private java.lang.String m_instrumentableName

Deprecated.

Instrumentable Name assigned to this Instrumentable

Constructor Detail

ExcaliburComponentManager

public ExcaliburComponentManager()

Deprecated.

Create a new ExcaliburComponentManager.

ExcaliburComponentManager

public ExcaliburComponentManager(java.lang.ClassLoader loader)

Deprecated.

Create a new ExcaliburComponentManager with uses a specific Classloader.

ExcaliburComponentManager

public ExcaliburComponentManager(org.apache.avalon.framework.component.ComponentManager manager,
                         java.lang.ClassLoader loader)

Deprecated.

Create the ComponentLocator with a Classloader and parent ComponentLocator

ExcaliburComponentManager

public ExcaliburComponentManager(org.apache.avalon.framework.component.ComponentManager manager)

Deprecated.

Create the ComponentLocator with a parent ComponentLocator

Method Detail

lookup

public org.apache.avalon.framework.component.Component lookup(java.lang.String role)
                                                       throws org.apache.avalon.framework.component.ComponentException

Deprecated.

Return an instance of a component based on a Role. The Role is usually the Interface's Fully Qualified Name(FQN)--unless there are multiple Components for the same Role. In that case, the Role's FQN is appended with "Selector", and we return a ComponentSelector.

Specified by:

lookup in interface org.apache.avalon.framework.component.ComponentManager

Throws:

org.apache.avalon.framework.component.ComponentException

hasComponent

public boolean hasComponent(java.lang.String role)

Deprecated.

Tests for existence of a component. Please note that this test is for existing components, and a component will not be created to satisfy the request.

Specified by:

hasComponent in interface org.apache.avalon.framework.component.ComponentManager

release

public void release(org.apache.avalon.framework.component.Component component)

Deprecated.

Release a Component. This implementation makes sure it has a handle on the propper ComponentHandler, and let's the ComponentHandler take care of the actual work.

Specified by:

release in interface org.apache.avalon.framework.component.ComponentManager

configure

public void configure(org.apache.avalon.framework.configuration.Configuration configuration)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Deprecated.

Configure the ComponentLocator.

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

contextualize

public void contextualize(org.apache.avalon.framework.context.Context context)

Deprecated.

Set up the Component's Context.

Specified by:

contextualize in interface org.apache.avalon.framework.context.Contextualizable

initialize

public void initialize()
                throws java.lang.Exception

Deprecated.

Properly initialize of the Child handlers.

Specified by:

initialize in interface org.apache.avalon.framework.activity.Initializable

Throws:

java.lang.Exception

dispose

public void dispose()

Deprecated.

Properly dispose of the Child handlers.

Specified by:

dispose in interface org.apache.avalon.framework.activity.Disposable

setRoleManager

public void setRoleManager(RoleManager roles)

Deprecated.

Configure the RoleManager

Specified by:

setRoleManager in interface RoleManageable

setLogKitManager

public void setLogKitManager(org.apache.avalon.excalibur.logger.LogKitManager logkit)

Deprecated.

Configure the LogKitManager

Specified by:

setLogKitManager in interface org.apache.avalon.excalibur.logger.LogKitManageable

setInstrumentManager

public void setInstrumentManager(org.apache.excalibur.instrument.InstrumentManager instrumentManager)

Deprecated.

Sets the InstrumentManager for child components. Can be for special purpose components, however it is used mostly internally.

Specified by:

setInstrumentManager in interface org.apache.excalibur.instrument.InstrumentManageable

Parameters:

instrumentManager - The InstrumentManager for the component to use.

setInstrumentableName

public void setInstrumentableName(java.lang.String name)

Deprecated.

Sets the name for the Instrumentable. The Instrumentable Name is used to uniquely identify the Instrumentable during the configuration of the InstrumentManager and to gain access to an InstrumentableDescriptor through the InstrumentManager. The value should be a string which does not contain spaces or periods.

This value may be set by a parent Instrumentable, or by the InstrumentManager using the value of the 'instrumentable' attribute in the configuration of the component.

Specified by:

setInstrumentableName in interface org.apache.excalibur.instrument.Instrumentable

Parameters:

name - The name used to identify a Instrumentable.

getInstrumentableName

public java.lang.String getInstrumentableName()

Deprecated.

Gets the name of the Instrumentable.

Specified by:

getInstrumentableName in interface org.apache.excalibur.instrument.Instrumentable

Returns:

The name used to identify a Instrumentable.

getInstruments

public org.apache.excalibur.instrument.Instrument[] getInstruments()

Deprecated.

Obtain a reference to all the Instruments that the Instrumentable object wishes to expose. All sampling is done directly through the Instruments as opposed to the Instrumentable interface.

Specified by:

getInstruments in interface org.apache.excalibur.instrument.Instrumentable

Returns:

An array of the Instruments available for profiling. Should never be null. If there are no Instruments, then EMPTY_INSTRUMENT_ARRAY can be returned. This should never be the case though unless there are child Instrumentables with Instruments.

getChildInstrumentables

public org.apache.excalibur.instrument.Instrumentable[] getChildInstrumentables()

Deprecated.

Any Object which implements Instrumentable can also make use of other Instrumentable child objects. This method is used to tell the InstrumentManager about them.

Specified by:

getChildInstrumentables in interface org.apache.excalibur.instrument.Instrumentable

Returns:

An array of child Instrumentables. This method should never return null. If there are no child Instrumentables, then EMPTY_INSTRUMENTABLE_ARRAY can be returned.

removeDisposedHandlers

private void removeDisposedHandlers(java.util.List disposed)

Deprecated.

setLoggerManager

public void setLoggerManager(org.apache.avalon.excalibur.logger.LoggerManager logkit)

Deprecated.

Configure the LoggerManager.

Specified by:

setLoggerManager in interface org.apache.avalon.excalibur.logger.LoggerManageable

getComponentHandler

protected ComponentHandler getComponentHandler(java.lang.String role,
                                   java.lang.Class componentClass,
                                   org.apache.avalon.framework.configuration.Configuration configuration,
                                   org.apache.avalon.framework.context.Context context,
                                   RoleManager roleManager,
                                   LogkitLoggerManager logkitManager)
                                        throws java.lang.Exception

Deprecated.

Obtain a new ComponentHandler for the specified component. This method allows classes which extend the ExcaliburComponentManager to use their own ComponentHandlers.

Parameters:

componentClass - Class of the component for which the handle is being requested.

configuration - The configuration for this component.

context - The current context object.

roleManager - The current RoleManager.

logkitManager - The current LogKitManager.

Throws:

java.lang.Exception - If there were any problems obtaining a ComponentHandler

addComponent

public void addComponent(java.lang.String role,
                java.lang.Class component,
                org.apache.avalon.framework.configuration.Configuration configuration)
                  throws org.apache.avalon.framework.component.ComponentException

Deprecated.

Add a new component to the manager.

Parameters:

role - the role name for the new component.

component - the class of this component.

configuration - the configuration for this component.

Throws:

org.apache.avalon.framework.component.ComponentException

addComponentInstance

public void addComponentInstance(java.lang.String role,
                        org.apache.avalon.framework.component.Component instance)

Deprecated.

Add a static instance of a component to the manager.

Parameters:

role - the role name for the component.

instance - the instance of the component.