atg.nucleus

Interface Configuration

public interface Configuration

A Configuration is an object that knows how to create and configure a service in the nucleus hierarchy.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Modifier and Type	Method and Description
void	configureService(java.lang.Object pService, NameResolver pResolver, ApplicationLogging pLog) Configures the service object
void	configureState(atg.nucleus.ConfigurationState pState) Updates a ConfigurationState to reflect the state of a component as newly configured by this Configuration.
java.lang.Object	createNewInstance(ApplicationLogging pLog) Creates a new instance of the service object.
java.lang.String	getDescription() Returns a short description of the service object.
java.lang.String[]	getRequiredPropertyNames() Set the required property names.
java.lang.String	getScope() Returns the "scope" into which the newly created component should be placed.
java.lang.Class	getServiceClass() Returns the class to which the service object belongs.
java.lang.String	getServiceName() Returns the name of the service that will be created by this configuration
atg.nucleus.ConfigurationSource[]	getSources() Returns an array of ConfigurationSources that contributed information to this ConfigurationState.
void	setRequiredPropertyNames(java.lang.String[] pRequiredPropertyNames) Set the required property names.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getServiceName

java.lang.String getServiceName()

Returns the name of the service that will be created by this configuration

getScope

java.lang.String getScope()

Returns the "scope" into which the newly created component should be placed.

getServiceClass

java.lang.Class getServiceClass()

Returns the class to which the service object belongs.

getDescription

java.lang.String getDescription()

Returns a short description of the service object.

createNewInstance

java.lang.Object createNewInstance(ApplicationLogging pLog)

Creates a new instance of the service object. Returns null if unable to create the new instance.

Parameters:

pLog - the ApplicationLogging to which any errors should be written

configureService

void configureService(java.lang.Object pService,
                      NameResolver pResolver,
                      ApplicationLogging pLog)

Configures the service object

Parameters:

pService - the object to be configured

pResolver - the NameResolver that should be used to find other services named during the configuration

pLog - the ApplicationLogging to which any errors should be written

configureState

void configureState(atg.nucleus.ConfigurationState pState)

Updates a ConfigurationState to reflect the state of a component as newly configured by this Configuration. Properties that are not actually modified by the configuration need not be updated; they will be defaulted as part of the process of initializing the ConfigurationState.

Parameters:

pState - the ConfigurationState to be updated.

getSources

atg.nucleus.ConfigurationSource[] getSources()

Returns an array of ConfigurationSources that contributed information to this ConfigurationState.

setRequiredPropertyNames

void setRequiredPropertyNames(java.lang.String[] pRequiredPropertyNames)

Set the required property names. Used to cache the required property names on a Configuration. Used by ServiceUtil.

getRequiredPropertyNames

java.lang.String[] getRequiredPropertyNames()

Set the required property names. Used to cache the required property names on a Configuration. Used by ServiceUtil.