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 org.jcontainer.dna.Logger;
11
12 /***
13 * <p>LoggerStore represents the logging hierarchy for a Logger, as defined by
14 * its configuration.</p> <p>The LoggerStore has an associated
15 * LoggerStoreFactory which also acts as a configurator for the Logger.</p>
16 * <p>Whenever an application has finished using the LoggerStore it will call
17 * the close() method indicating that the logger hierarchy should also be
18 * shutdown. </p>
19 *
20 * @author <a href="mailto:mauro.talevi at aquilonia.org">Mauro Talevi</a>
21 * @author Peter Donald
22 */
23 public interface LoggerStore
24 {
25 /***
26 * Retrieves the root Logger from the store.
27 *
28 * @return the Logger
29 * @throws Exception if unable to retrieve Logger
30 */
31 Logger getLogger()
32 throws Exception;
33
34 /***
35 * Retrieves a Logger hierarchy from the store for a given category name.
36 *
37 * @param categoryName the name of the logger category.
38 * @return the Logger
39 * @throws Exception if unable to retrieve Logger
40 */
41 Logger getLogger( String categoryName )
42 throws Exception;
43
44 /***
45 * Closes the LoggerStore and shuts down the logger hierarchy.
46 */
47 void close();
48 }
49
This page was automatically generated by Maven