org.apache.isis.core.commons.config

Class InstallerAbstract

java.lang.Object

org.apache.isis.core.commons.config.InstallerAbstract

All Implemented Interfaces:

ApplicationScopedComponent, Component, Installer, IsisConfigurationAware, IsisConfigurationBuilderAware

Direct Known Subclasses:

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

public abstract class InstallerAbstract
extends Object
implements Installer, IsisConfigurationBuilderAware, IsisConfigurationAware

Constructor Summary

Constructors

Constructor and Description
InstallerAbstract(String type, String name) Subclasses should pass in the type defined as a constant in the subinterface of Installer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addConfigurationResources(List<String> configurationResources) Optional hook method to allow subclasses to specify any additional config resources.
IsisConfiguration	getConfiguration() Returns a snapshot of the current configuration provided by the injected IsisConfigurationBuilder.
List<String>	getConfigurationResources() Returns [type.properties, type_name.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.
void	init() Default implementation does nothing.
protected static List<Class<?>>	listOf(Class<?>... classes) Helper for subclasses implementing Installer.getTypes().
protected static List<Class<?>>	listOf(List<Class<?>> classList, Class<?>... classes) Helper for subclasses implementing Installer.getTypes().
void	setConfiguration(IsisConfiguration configuration) Either this method or setConfigurationBuilder(IsisConfigurationBuilder) should be called prior to calling getConfiguration().
void	setConfigurationBuilder(IsisConfigurationBuilder isisConfigurationBuilder) Either this method or setConfiguration(IsisConfiguration) should be called prior to calling getConfiguration().
void	shutdown() Default implementation does nothing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getTypes

Constructor Detail

InstallerAbstract

public InstallerAbstract(String type,
                 String name)

Subclasses should pass in the type defined as a constant in the subinterface of Installer.

For example, PersistenceMechanismInstaller has a constant PersistenceMechanismInstaller#TYPE. Any implementation of PersistenceMechanismInstaller should pass this constant value up to this constructor.

Method Detail

getType

public String getType()

Description copied from interface: Installer

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 Installer.getName(), to determine the config files and config keys for this installer.

Specified by:

getType in interface Installer

See Also:

Installer.getConfigurationResources()

getName

public String getName()

Description copied from interface: Installer

The name (qualified by type).

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

Specified by:

getName in interface Installer

See Also:

Installer.getConfigurationResources()

getConfigurationResources

public List<String> getConfigurationResources()

Returns [type.properties, type_name.properties.

For example, [persistor.properties, persistor_in-memory.properties].

Specified by:

getConfigurationResources in interface Installer

See Also:

getType(), getName()

addConfigurationResources

protected void addConfigurationResources(List<String> configurationResources)

Optional hook method to allow subclasses to specify any additional config resources.

init

public void init()

Default implementation does nothing.

Specified by:

init in interface ApplicationScopedComponent

shutdown

public void shutdown()

Default implementation does nothing.

Specified by:

shutdown in interface ApplicationScopedComponent

setConfigurationBuilder

public void setConfigurationBuilder(IsisConfigurationBuilder isisConfigurationBuilder)

Either this method or setConfiguration(IsisConfiguration) should be called prior to calling getConfiguration().

If a configuration has already been provided, then throws IllegalStateException.

Specified by:

setConfigurationBuilder in interface IsisConfigurationBuilderAware

setConfiguration

public void setConfiguration(IsisConfiguration configuration)

Either this method or setConfigurationBuilder(IsisConfigurationBuilder) should be called prior to calling getConfiguration().

If a configuration builder has already been provided, then throws IllegalStateException.

Specified by:

setConfiguration in interface IsisConfigurationAware

getConfiguration

public IsisConfiguration getConfiguration()

Returns a snapshot of the current configuration provided by the injected IsisConfigurationBuilder.

Implementation note: the implementation is in fact just InstallerLookupDefault.

listOf

protected static List<Class<?>> listOf(Class<?>... classes)

Helper for subclasses implementing Installer.getTypes().

listOf

protected static List<Class<?>> listOf(List<Class<?>> classList,
                    Class<?>... classes)

Helper for subclasses implementing Installer.getTypes().