01: /**
02: * Copyright (C) 2001-2003 France Telecom R&D
03: *
04: * This library is free software; you can redistribute it and/or
05: * modify it under the terms of the GNU Lesser General Public
06: * License as published by the Free Software Foundation; either
07: * version 2 of the License, or (at your option) any later version.
08: *
09: * This library is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12: * Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public
15: * License along with this library; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */package org.objectweb.util.monolog.api;
18:
19: /**
20: * <P>The aims of this interface is to provide Logger instances, to allow
21: * instrumentation to be independent of the logging implementation and
22: * to allow the use of the same logging implementation for all the
23: * components of a given application.</P>
24: *
25: * <P>This interface provides two methods to fetch Logger. If the Logger
26: * described by the parameters does not exist, then the LoggerFactory
27: * must return a new instance of Logger.</P>
28: *
29: * <P>The LoggerFactory interface also provides accessors to a resource
30: * bundle name associated to a LoggerFactory. This interface allows defining
31: * a resource bundle name used by all Logger.</P>
32: *
33: * @author S.Chassande-Barrioz
34: */
35: public interface LoggerFactory {
36:
37: /**
38: * This method permits to fetch a Logger. If the Logger
39: * described by the parameters does not exist, then the LoggerFactory
40: * must return a new instance of Logger.
41: * The key parameter is a description of the expected Logger. In simple
42: * cases, the key is the initial topic of the Logger.
43: */
44: Logger getLogger(String key);
45:
46: /**
47: * This method permits to fetch a Logger. If the Logger
48: * described by the parameters does not exist, then the LoggerFactory
49: * must return a new instance of Logger.
50: * The key parameter is a description of the expected Logger. In simple
51: * cases, the key is the initial topic of the Logger.
52: * The resourceBundleName parameter allows specifying the name of a
53: * resource bundle in order to internationalise the logging.
54: */
55: Logger getLogger(String key, String resourceBundleName);
56:
57: /**
58: * Accessors to a resource bundle name associated to a LoggerFactory.
59: */
60: String getResourceBundleName();
61:
62: /**
63: * Accessors to a resource bundle name associated to a LoggerFactory.
64: */
65: void setResourceBundleName(String resourceBundleName);
66:
67: /**
68: * It retrieves a list of all loggers.
69: */
70: Logger[] getLoggers();
71:
72: /**
73: * A Logger Factory can have a prefix helping for isolate applications. To
74: * assume the isolation, a prefix can be used for topic name.
75: * @return the prefix of the topic name.
76: */
77: String getTopicPrefix();
78: }
|