org.sape.carbon.core.component
Interface ComponentConfiguration

All Superinterfaces:

Configuration

All Known Subinterfaces:

BaseMRUCacheConfiguration, BoundedBufferPerformanceLoggerConfiguration, CarbonManagementServiceConfiguration, ConfigurationTypeServiceConfiguration, DeploymentServiceConfiguration, HomeFactoryConfiguration, HttpAdaptorConfiguration, InitialContextFactoryConfiguration, JrmpRemotingConfiguration, MailConfiguration, MBeanServerConfiguration, MRUCacheConfiguration, MultiGetMRUCacheConfiguration, NamedDataSourceConnectionFactoryConfiguration, RemoteHomeFactoryConfiguration, SchedulerServiceConfiguration, SqlBeanDataLoaderConfiguration, SqlBeanMapMRUDataLoaderConfiguration, StandaloneConnectionFactoryConfiguration, StartupServiceConfiguration, StatementFactoryConfiguration, ThreadPoolConfiguration, TotalCacheConfiguration, UniqueIDServiceConfiguration, WebLogicMBeanServerServiceConfiguration

public interface ComponentConfiguration

extends Configuration

This configuration is meant to be the base configurations needed for a Carbon Component. It provides the base configuration sub-system with the necessary configurations to enable the component to be started.

Copyright 2001 Sapient

Since:

carbon 1.0

Version:

$Revision: 1.14 $($Author: dvoet $ / $Date: 2003/05/05 21:21:11 $)

Author:

Greg Hinkle, January 2001

Field Summary

static String

ComponentTemplateName The name of the default component template configuration used to build components.

Method Summary

String	getComponentDescription() Provides access to the optional description for the configured component.
String	getComponentTemplateName() Provides access to the component template configuration name.
Class	getFunctionalImplementationClass() The method returns the Class object for the class that implements this component's service.
Class	getFunctionalInterface() This method returns the class of the implemented interface for this service.
void	setComponentDescription(String description) Set the Component's Description.
void	setComponentTemplateName(String configurationName) Sets the name of the component Template.
void	setFunctionalImplementationClass(Class functionalImplementationClass) Sets the Class object of the type that is providing the implementation of this component.
void	setFunctionalInterface(Class functionalInterfaceClass) Sets the interface class that this component is providing.

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Field Detail

ComponentTemplateName

public static final String ComponentTemplateName

The name of the default component template configuration used to build components. The component template configuration object is used define the assistants and their relationship to the component.

See Also:

Constant Field Values

Method Detail

getFunctionalInterface

public Class getFunctionalInterface()

This method returns the class of the implemented interface for this service. The Component Class must be an implementation of this interface.

Returns:

Class The class object of the interface implemented by this component.

setFunctionalInterface

public void setFunctionalInterface(Class functionalInterfaceClass)

Sets the interface class that this component is providing.

Parameters:

functionalInterfaceClass - the Class object for the interface that the component is providing an implementation for.

getFunctionalImplementationClass

public Class getFunctionalImplementationClass()

The method returns the Class object for the class that implements this component's service. This Class object must not be abstract and must be public. This class must also have a public default constructor to allow the ComponentBuilder to instantiate it.

Returns:

Class The class object that implements this component

setFunctionalImplementationClass

public void setFunctionalImplementationClass(Class functionalImplementationClass)

Sets the Class object of the type that is providing the implementation of this component.

Parameters:

functionalImplementationClass - The Class object that implements this component.

getComponentTemplateName

public String getComponentTemplateName()

Provides access to the component template configuration name.

Returns:

the name of the component template configuration for this component configuration

setComponentTemplateName

public void setComponentTemplateName(String configurationName)

Sets the name of the component Template.

Parameters:

configurationName - The name of the configuration that defines the template construction of this component.

getComponentDescription

public String getComponentDescription()

Provides access to the optional description for the configured component.

Returns:

the description of this component

setComponentDescription

public void setComponentDescription(String description)

Set the Component's Description.

Parameters:

description - a user readable note describing this component and its purpose