org.apache.avalon.fortress

Interface RoleManager

public interface RoleManager

RoleManager Interface, use this to specify the Components and how they correspond to easy shorthand names. The RoleManager assumes a one to one relationship of shorthand names to classes, and a flat relationship of classes to roles. Any one role can have multiple classes associated with it.

Since:

4.1

Version:

CVS $Revision: 1.9 $ $Date: 2004/02/28 15:16:24 $

Author:

Avalon Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ROLE Convenience constant to make lookup of the RoleManager easer.

Method Summary

Methods

Modifier and Type	Method and Description
RoleEntry	getRoleForClassname(java.lang.String classname) Get a RoleEntry for a component type.
RoleEntry	getRoleForShortName(java.lang.String shortname) Get a RoleEntry for a short name.

Field Detail

ROLE

static final java.lang.String ROLE

Convenience constant to make lookup of the RoleManager easer.

Method Detail

getRoleForShortName

RoleEntry getRoleForShortName(java.lang.String shortname)

Get a RoleEntry for a short name. The short name is an alias for a component type.

Parameters:

shortname - The shorthand name for the component type.

Returns:

the proper RoleEntry

getRoleForClassname

RoleEntry getRoleForClassname(java.lang.String classname)

Get a RoleEntry for a component type. This facilitates self-healing configuration files where the impl reads the configuration and translates all <component/> entries to use the short hand name for readability.

Parameters:

classname - The component type name

Returns:

the proper RoleEntry