org.apache.avalon.excalibur.component

Class DefaultRoleManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.avalon.excalibur.component.AbstractDualLogEnabled

org.apache.avalon.excalibur.component.DefaultRoleManager

All Implemented Interfaces:

RoleManager, org.apache.avalon.framework.configuration.Configurable, org.apache.avalon.framework.logger.LogEnabled, org.apache.avalon.framework.logger.Loggable

Deprecated.

ECM is no longer supported

public class DefaultRoleManager
extends AbstractDualLogEnabled
implements RoleManager, org.apache.avalon.framework.configuration.Configurable

Default RoleManager implementation. It populates the RoleManager from a configuration file.

Since:

4.0

Version:

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

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map	m_classNames Deprecated. Map for role to default classname mapping
private java.util.Map	m_hintClassNames Deprecated. Map for role->hint to classname mapping
private RoleManager	m_parent Deprecated. Parent RoleManager for nested resolution
private java.util.Map	m_shorthands Deprecated. Map for shorthand to role mapping

Constructor Summary

Constructors

Constructor and Description
DefaultRoleManager() Deprecated. Default constructor--this RoleManager has no parent.
DefaultRoleManager(RoleManager parent) Deprecated. Alternate constructor--this RoleManager has the specified parent.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(org.apache.avalon.framework.configuration.Configuration configuration) Deprecated. Reads a configuration object and creates the role, shorthand, and class name mapping.
java.lang.String	getDefaultClassNameForHint(java.lang.String role, java.lang.String shorthand) Deprecated. Retrieves a default class name for a role/hint combination.
java.lang.String	getDefaultClassNameForRole(java.lang.String role) Deprecated. Retrieves the default class name for the specified role.
java.lang.String	getRoleForName(java.lang.String shorthandName) Deprecated. Retrieves the real role name from a shorthand name.

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_shorthands

private java.util.Map m_shorthands

Deprecated.

Map for shorthand to role mapping

m_classNames

private java.util.Map m_classNames

Deprecated.

Map for role to default classname mapping

m_hintClassNames

private java.util.Map m_hintClassNames

Deprecated.

Map for role->hint to classname mapping

m_parent

private final RoleManager m_parent

Deprecated.

Parent RoleManager for nested resolution

Constructor Detail

DefaultRoleManager

public DefaultRoleManager()

Deprecated.

Default constructor--this RoleManager has no parent.

DefaultRoleManager

public DefaultRoleManager(RoleManager parent)

Deprecated.

Alternate constructor--this RoleManager has the specified parent.

Parameters:

parent - The parent RoleManager.

Method Detail

getRoleForName

public final java.lang.String getRoleForName(java.lang.String shorthandName)

Deprecated.

Retrieves the real role name from a shorthand name. Usually the shorthand name refers to a configuration element name. If this RoleManager does not have the match, and there is a parent RoleManager, the parent will be asked to resolve the role.

Specified by:

getRoleForName in interface RoleManager

Parameters:

shorthandName - The shortname that is an alias for the role.

Returns:

the official role name.

getDefaultClassNameForRole

public final java.lang.String getDefaultClassNameForRole(java.lang.String role)

Deprecated.

Retrieves the default class name for the specified role. This is only called when the configuration does not specify the class explicitly. If this RoleManager does not have the match, and there is a parent RoleManager, the parent will be asked to resolve the class name.

Specified by:

getDefaultClassNameForRole in interface RoleManager

Parameters:

role - The role that has a default implementation.

Returns:

the Fully Qualified Class Name (FQCN) for the role.

getDefaultClassNameForHint

public final java.lang.String getDefaultClassNameForHint(java.lang.String role,
                                          java.lang.String shorthand)

Deprecated.

Retrieves a default class name for a role/hint combination. This is only called when a role is mapped to a DefaultComponentSelector, and the configuration elements use shorthand names for the type of component. If this RoleManager does not have the match, and there is a parent RoleManager, the parent will be asked to resolve the class name.

Specified by:

getDefaultClassNameForHint in interface RoleManager

Parameters:

role - The role that this shorthand refers to.

shorthand - The shorthand name for the type of Component

Returns:

the FQCN for the role/hint combination.

configure

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

Deprecated.

Reads a configuration object and creates the role, shorthand, and class name mapping.

Specified by:

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

Parameters:

configuration - The configuration object.

Throws:

org.apache.avalon.framework.configuration.ConfigurationException - if the configuration is malformed