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. The Configurables that come with the project are a Pazpar2 client and a Service Proxy client

Author:
Niels Erik

Method Summary
 void configure(ConfigurationReader reader)
          Configures the Configurable using the configuration obtained by the provided configuration reader
 List<String> documentConfiguration()
          The components documentation of how it was configured.
 Map<String,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
 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

Map<String,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

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

List<String> documentConfiguration()
The components documentation of how it was configured.

Returns:
a list of Strings describing configuration details


Copyright © 2013. All Rights Reserved.