com.indexdata.mkjsf.config

Interface Configurable

All Known Subinterfaces:

SearchClient

All Known Implementing Classes:

Pz2Client, Pz2Service, ServiceProxyClient

public interface Configurable

Interface to be implemented by any part of an application that wish to use a ConfigurationReader for it's configuration. See config package info page for more information.

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(ConfigurationReader reader) Configures the Configurable using the configuration obtained by the provided configuration reader
java.util.List<java.lang.String>	documentConfiguration() The components documentation of how it was configured.
java.util.Map<java.lang.String,java.lang.String>	getDefaults() Returns the default parameters that the configurable has defined for itself Should be invoked by the configuration reader before it possibly overrides some parameters obtained from the external configuration source
java.lang.String	getModuleName() Returns the name of the module, can be used by a configuration reader that distinguishes between sets of configuration properties by component name, a name space of sorts.

Method Detail

configure

void configure(ConfigurationReader reader)
               throws ConfigurationException

Configures the Configurable using the configuration obtained by the provided configuration reader

Parameters:

reader - used for reading the configuration

Throws:

ConfigurationException

getDefaults

java.util.Map<java.lang.String,java.lang.String> getDefaults()

Returns the default parameters that the configurable has defined for itself Should be invoked by the configuration reader before it possibly overrides some parameters obtained from the external configuration source

Returns:

getModuleName

java.lang.String getModuleName()

Returns the name of the module, can be used by a configuration reader that distinguishes between sets of configuration properties by component name, a name space of sorts.

Returns:

name of the part that is to be configured

documentConfiguration

java.util.List<java.lang.String> documentConfiguration()

The components documentation of how it was configured.

Returns:

a list of Strings describing configuration details