org.apache.turbine.services.avaloncomponent
Interface AvalonComponentService

All Superinterfaces:

Initable, Service

All Known Implementing Classes:

ACSYaafiComponentService, TurbineAvalonComponentService

public interface AvalonComponentService

extends Service

This service allows access to avalon components.

Version:

$Id: AvalonComponentService.java 534527 2007-05-02 16:10:59Z tv $

Author:

Quinton McCombs, Henning P. Schmiedehausen

Field Summary

static java.lang.String	AVALON_LOG_CATEGORY Where we write the Avalon Logger messages
static java.lang.String	COMPONENT_APP_ROOT Key used in the context for defining the application root
static java.lang.String	COMPONENT_CONFIG_KEY property specifing file name of the component config file
static java.lang.String	COMPONENT_CONFIG_VALUE property specifing file name of the component config file
static java.lang.String	COMPONENT_LOOKUP_KEY property for the Components to look up
static java.lang.String	COMPONENT_ROLE_KEY property specifing file name of the component role file
static java.lang.String	COMPONENT_ROLE_VALUE property specifing file name of the component role file
static java.lang.String	SERVICE_NAME The publically visible name of the service

Method Summary

org.apache.avalon.framework.component.Component	lookup(java.lang.String roleName) Returns an instance of the named component
void	release(org.apache.avalon.framework.component.Component component) Releases the component

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Field Detail

SERVICE_NAME

public static final java.lang.String SERVICE_NAME

The publically visible name of the service

See Also:

Constant Field Values

AVALON_LOG_CATEGORY

public static final java.lang.String AVALON_LOG_CATEGORY

Where we write the Avalon Logger messages

See Also:

Constant Field Values

COMPONENT_CONFIG_KEY

public static final java.lang.String COMPONENT_CONFIG_KEY

property specifing file name of the component config file

See Also:

Constant Field Values

COMPONENT_CONFIG_VALUE

public static final java.lang.String COMPONENT_CONFIG_VALUE

property specifing file name of the component config file

See Also:

Constant Field Values

COMPONENT_ROLE_KEY

public static final java.lang.String COMPONENT_ROLE_KEY

property specifing file name of the component role file

See Also:

Constant Field Values

COMPONENT_ROLE_VALUE

public static final java.lang.String COMPONENT_ROLE_VALUE

property specifing file name of the component role file

See Also:

Constant Field Values

COMPONENT_LOOKUP_KEY

public static final java.lang.String COMPONENT_LOOKUP_KEY

property for the Components to look up

See Also:

Constant Field Values

COMPONENT_APP_ROOT

public static final java.lang.String COMPONENT_APP_ROOT

Key used in the context for defining the application root

See Also:

Constant Field Values

Method Detail

lookup

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

Returns an instance of the named component

Parameters:

roleName - Name of the role the component fills.

Returns:

an instance of the named component

Throws:

org.apache.avalon.framework.component.ComponentException - generic exception

release

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

Releases the component

Parameters:

component - the component to release