1 /*
2 * Copyright (C) The Spice Group. All rights reserved.
3 *
4 * This software is published under the terms of the Spice
5 * Software License version 1.1, a copy of which has been included
6 * with this distribution in the LICENSE.txt file.
7 */
8 package org.codehaus.spice.loggerstore;
9
10 import java.util.Map;
11
12 /***
13 * <p>LoggerStoreFactory is a factory interface for LoggerStore instances. There
14 * is a factory implementation for each specific logger implementation (LogKit,
15 * Log4J, JDK14).
16 *
17 * <p>The factory also acts a configurator, handling the specific way in which a
18 * logger is configured. The LoggerStore is configured via a map of parameters
19 * passed in the create method. LoggerStoreFactory defines the keys used to
20 * retrieve the elements of the map.</p>
21 *
22 * @author <a href="mailto:mauro.talevi at aquilonia.org">Mauro Talevi</a>
23 * @author Peter Donald
24 * @version $Revision: 1.1 $ $Date: 2003/11/19 18:22:44 $
25 */
26 public interface LoggerStoreFactory
27 {
28 /***
29 * The URL key. Used to define the URL where the configuration for
30 * LoggerStore can be found.
31 */
32 String URL_LOCATION = "org.codehaus.spice.loggerstore.url";
33
34 /***
35 * The URL key. Used to define the URL where the configuration for
36 * LoggerStore can be found.
37 */
38 String FILE_LOCATION = "org.codehaus.spice.loggerstore.file";
39
40 /***
41 * Creates a LoggerStore from a given set of configuration parameters.
42 *
43 * @param config the Map of parameters for the configuration of the store
44 * @return the LoggerStore
45 * @throws Exception if unable to create the LoggerStore
46 */
47 LoggerStore createLoggerStore( Map config )
48 throws Exception;
49 }
This page was automatically generated by Maven