1 package com.indexdata.mkjsf.config;
\r
3 import java.io.Serializable;
\r
4 import java.util.List;
\r
6 import com.indexdata.mkjsf.errors.ConfigurationException;
\r
9 * Interface to be implemented by classes that read configurations from a source -
\r
10 * i.e. from web.xml, the file system, a database or hard-coded.
\r
12 * @author Niels Erik
\r
15 public interface ConfigurationReader extends Serializable {
\r
18 * Returns a Configuration to be used by the given Configurable
\r
20 * @param configurable the configurable to be configured by a configuration obtained by this reader
\r
21 * @return a Configuration, basically a set of key-value pairs
\r
22 * @throws ConfigurationException
\r
24 public Configuration getConfiguration(Configurable configurable) throws ConfigurationException;
\r
27 * Returns documentation for the key-value pairs obtained by this reader
\r
30 public List<String> document();
\r