org.nakedobjects.metamodel.commons.component
Interface Installer

All Superinterfaces:
ApplicationScopedComponent, Component
All Known Subinterfaces:
FacetDecoratorInstaller, NakedObjectReflectorInstaller

public interface Installer
extends ApplicationScopedComponent

A factory for a component, used during it boot strapping process.

All installers listed (by class name) in installer-registry.properties are loaded when the boot strap class is initially loaded. Then named installers are used during boot to create components for the system. The name method specified is the name that the component can be installed by.


Method Summary
 java.util.List<java.lang.String> getConfigurationResources()
          The configuration resources (files) to merge in configuration properties.
 java.lang.String getName()
          The name (qualified by type).
 java.lang.String getType()
          The type of the installer, meaning the component type, and consistent with the long option of the command line flag where applicable.
 
Methods inherited from interface org.nakedobjects.metamodel.commons.component.ApplicationScopedComponent
init, shutdown
 

Method Detail

getType

java.lang.String getType()
The type of the installer, meaning the component type, and consistent with the long option of the command line flag where applicable.

Examples are authentication or persistor.

Because all implementations of a given subinterface of Installer should return the same value for this method, by convention these subinterfaces define a constant which the implementation can just return.

Used, with getName(), to determine the config files and config keys for this installer.

See Also:
getConfigurationResources()

getName

java.lang.String getName()
The name (qualified by type).

Used, with getType(), to determine the config files and config keys for this installer.

See Also:
getConfigurationResources()

getConfigurationResources

java.util.List<java.lang.String> getConfigurationResources()
The configuration resources (files) to merge in configuration properties.

For example, would return list of [persistor.properties, and persistor_in-memory.properties] for the in-memory object store.

The implementation should look under keys prefixed either nakedobjects.persistor or nakedobjects.persistor.in-memory.

Note that we use an '_' underscore to join the type and name in the filenames, but a '.' (period) for the keys.



Copyright © 2001-2009 Naked Objects Group Ltd.. All Rights Reserved.