org.apache.isis.core.commons.components

Interface Installer

All Superinterfaces:

ApplicationScopedComponent, Component

All Known Subinterfaces:

AuthenticationManagerInstaller, AuthorizationManagerInstaller, FacetDecoratorInstaller, ObjectReflectorInstaller, TemplateImageLoaderInstaller

All Known Implementing Classes:

AuthenticationManagerStandardInstallerAbstract, AuthorizationManagerStandardInstallerAbstract, HelpFacetDecoratorUsingFilesInstaller, I18nDecoratorUsingResourceBundleInstaller, InstallerAbstract, JavaReflectorInstallerNoDecorators, TemplateImageLoaderAwtInstaller, TemplateImageLoaderNoopInstaller

public interface Installer
extends ApplicationScopedComponent

A factory for a Component, defining that component's type and its name.

The (type, name) is expected to be a unique identifier of a component.

The default runtime (org.apache.isis.runtimes.dflt module), which adopts a service locator design, uses the installer-registry.properties resource as a registry of all available installers. The installers are loaded and indexed by their name and type. Other runtime implementations may use different approaches.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getConfigurationResources() The configuration resources (files) to merge in configuration properties.
String	getName() The name (qualified by type).
String	getType() The type of the installer, meaning the component type, and consistent with the long option of the command line flag where applicable.
List<Class<?>>	getTypes() The (classes of) the types that this installer makes available in the module.

Methods inherited from interface org.apache.isis.core.commons.components.ApplicationScopedComponent

init, shutdown

Method Detail

getType

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

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

List<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 isis.persistor or isis.persistor.in-memory.

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

getTypes

List<Class<?>> getTypes()

The (classes of) the types that this installer makes available in the module.