public interface Configuration
A Configuration is an object that knows how to create and configure a service in the nucleus hierarchy.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
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.
|
static final java.lang.String CLASS_VERSION
java.lang.String getServiceName()
java.lang.String getScope()
java.lang.Class getServiceClass()
java.lang.String getDescription()
java.lang.Object createNewInstance(ApplicationLogging pLog)
pLog
- the ApplicationLogging to which any errors should be writtenvoid configureService(java.lang.Object pService, NameResolver pResolver, ApplicationLogging pLog)
pService
- the object to be configuredpResolver
- the NameResolver that should be used to
find other services named during the configurationpLog
- the ApplicationLogging to which any errors should be writtenvoid configureState(atg.nucleus.ConfigurationState pState)
pState
- the ConfigurationState to be updated.atg.nucleus.ConfigurationSource[] getSources()
void setRequiredPropertyNames(java.lang.String[] pRequiredPropertyNames)
java.lang.String[] getRequiredPropertyNames()