GrepCode: org.slf4j.LoggerFactory (.java) - Class

Maven-Central
/
org.slf4j / slf4j-api
/
1.5.5

1.6.4
1.6.1
1.6.0
1.5.11
1.5.10
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.0
1.4.3
1.4.2
1.4.1
1.3.0
/
org.slf4j.LoggerFactory
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /* 
2
   * Copyright (c) 2004-2007 QOS.ch
3
   * All rights reserved.
4
   * 
5
   * Permission is hereby granted, free  of charge, to any person obtaining
6
   * a  copy  of this  software  and  associated  documentation files  (the
7
   * "Software"), to  deal in  the Software without  restriction, including
8
   * without limitation  the rights to  use, copy, modify,  merge, publish,
9
   * distribute,  sublicense, and/or sell  copies of  the Software,  and to
10
  * permit persons to whom the Software  is furnished to do so, subject to
11
  * the following conditions:
12
  * 
13
  * The  above  copyright  notice  and  this permission  notice  shall  be
14
  * included in all copies or substantial portions of the Software.
15
  * 
16
  * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
17
  * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
18
  * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
19
  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
  * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
22
  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23
  */
24
 
25
 package org.slf4j;
26
 
27
 import java.util.ArrayList;
28
 import java.util.Arrays;
29
 import java.util.List;
30
 
31
 import org.slf4j.helpers.SubstituteLoggerFactory;
32
 import org.slf4j.helpers.Util;
33
 import org.slf4j.impl.StaticLoggerBinder;

 The LoggerFactory is a utility class producing Loggers for
 various logging APIs, most notably for log4j, logback and JDK 1.4 logging.
 Other implementations such as NOPLogger and
 SimpleLogger are also supported.
 
 
 LoggerFactory is essentially a wrapper around an
 ILoggerFactory instance bound with LoggerFactory at
 compile time.
 
 

 Please note that all methods in LoggerFactory are static.
 
 
 Author(s):Ceki Gülcü
50
 
51
 public final class LoggerFactory {
52
 
53
   static ILoggerFactory loggerFactory;
54
 
55
   static final String NO_STATICLOGGERBINDER_URL = "http://www.slf4j.org/codes.html#StaticLoggerBinder";
56
   static final String NULL_LF_URL = "http://www.slf4j.org/codes.html#null_LF";
57
   static final String VERSION_MISMATCH = "http://www.slf4j.org/codes.html#version_mismatch";
58
   static final String SUBSTITUTE_LOGGER_URL = "http://www.slf4j.org/codes.html#substituteLogger";

  
 It is out responsibility to track version changes and manage the
 compatibility list.
 
 
 
65
 
66
   static private final String[] API_COMPATIBILITY_LIST = new String[] { "1.5.5" };
67
 
68
   // private constructor prevents instantiation
69
   private LoggerFactory() {
70
   }
71
 
72
   static {
73
     staticInitialize();
74
     versionSanityCheck();
75
   }
76
 
77
   private final static void staticInitialize() {
78
     try {
79
       // support re-entrant behavior.
80
       // See also http://bugzilla.slf4j.org/show_bug.cgi?id=106
81
       List loggerNameList = new ArrayList();
82
       loggerFactory = new SubstituteLoggerFactory(loggerNameList);
83
       loggerFactory = StaticLoggerBinder.SINGLETON.getLoggerFactory();
84
       emitSubstitureLoggerWarning(loggerNameList);
85
     } catch (NoClassDefFoundError ncde) {
86
       loggerFactory = null; // undo SubstituteLoggerFactory assignment
87
       String msg = ncde.getMessage();
88
       if (msg != null && msg.indexOf("org/slf4j/impl/StaticLoggerBinder") != -1) {
89
         Util
90
             .reportFailure("Failed to load class \"org.slf4j.impl.StaticLoggerBinder\".");
91
         Util.reportFailure("See " + NO_STATICLOGGERBINDER_URL
92
             + " for further details.");
93
 
94
       }
95
       throw ncde;
96
     } catch (Exception e) {
97
       loggerFactory = null; // undo SubstituteLoggerFactory assignment
98
       // we should never get here
99
       Util.reportFailure("Failed to instantiate logger ["
100
          + StaticLoggerBinder.SINGLETON.getLoggerFactoryClassStr() + "]", e);
101
    }
102
  }
103
104
  private final static void emitSubstitureLoggerWarning(List loggerNameList) {
105
    if (loggerNameList.size() == 0) {
106
      return;
107
    }
108
    Util
109
        .reportFailure("The following loggers will not work becasue they were created");
110
    Util
111
        .reportFailure("during the default configuration phase of the underlying logging system.");
112
    Util.reportFailure("See also " + SUBSTITUTE_LOGGER_URL);
113
    for (int i = 0; i < loggerNameList.size(); i++) {
114
      String loggerName = (String) loggerNameList.get(i);
115
      Util.reportFailure(loggerName);
116
    }
117
  }
118
119
  private final static void versionSanityCheck() {
120
    try {
121
      String requested = StaticLoggerBinder.REQUESTED_API_VERSION;
122
123
      boolean match = false;
124
      for (int i = 0; i < API_COMPATIBILITY_LIST.length; i++) {
125
        if (API_COMPATIBILITY_LIST[i].equals(requested)) {
126
          match = true;
127
        }
128
      }
129
      if (!match) {
130
        Util.reportFailure("The requested version " + requested
131
            + " by your slf4j binding is not compatible with "
132
            + Arrays.toString(API_COMPATIBILITY_LIST));
133
        Util.reportFailure("See " + VERSION_MISMATCH + " for further details.");
134
      }
135
    } catch (java.lang.NoSuchFieldError nsfe) {
136
      // given our large user base anbd SLF4J's commitment to backward
137
      // compatibility, we cannot cry
138
      // here. Only for implementations which willingly declare a
139
      // REQUESTED_API_VERSION field do we emit compatibility warnings.
140
    } catch (Throwable e) {
141
      // we should never reach here
142
      Util.reportFailure(
143
          "Unexpected problem occured during version sanity check", e);
144
    }
145
  }

  
 Return a logger named according to the name parameter using the statically
 bound ILoggerFactory instance.
 
 
 Parameters:name
                The name of the logger. Returns:logger
154
155
  public static Logger getLogger(String name) {
156
    if (loggerFactory == null) {
157
      throw new IllegalStateException(
158
          "Logging factory implementation cannot be null. See also "
159
              + NULL_LF_URL);
160
    }
161
    return loggerFactory.getLogger(name);
162
  }

  
 Return a logger named corresponding to the class passed as parameter, using
 the statically bound ILoggerFactory instance.
 
 
 Parameters:clazz
                the returned logger will be named after clazz Returns:logger
171
172
  public static Logger getLogger(Class clazz) {
173
    if (loggerFactory == null) {
174
      throw new IllegalStateException(
175
          "Logging factory implementation cannot be null. See also "
176
              + NULL_LF_URL);
177
    }
178
    return loggerFactory.getLogger(clazz.getName());
179
  }

  
 Return the ILoggerFactory instance in use.
 
 
 ILoggerFactory instance is bound with this class at compile time.
 
 
 Returns:the ILoggerFactory instance in use
188
189
  public static ILoggerFactory getILoggerFactory() {
190
    return loggerFactory;
191
  }
192
}