View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.simple;
18  
19  import java.io.FileNotFoundException;
20  import java.io.FileOutputStream;
21  import java.io.PrintStream;
22  import java.util.concurrent.ConcurrentHashMap;
23  import java.util.concurrent.ConcurrentMap;
24  
25  import org.apache.logging.log4j.Level;
26  import org.apache.logging.log4j.message.MessageFactory;
27  import org.apache.logging.log4j.spi.AbstractLogger;
28  import org.apache.logging.log4j.spi.ExtendedLogger;
29  import org.apache.logging.log4j.spi.LoggerContext;
30  import org.apache.logging.log4j.spi.LoggerContextKey;
31  import org.apache.logging.log4j.util.PropertiesUtil;
32  
33  /**
34   *
35   */
36  public class SimpleLoggerContext implements LoggerContext {
37  
38      /** The default format to use when formatting dates */
39      protected static final String DEFAULT_DATE_TIME_FORMAT = "yyyy/MM/dd HH:mm:ss:SSS zzz";
40  
41      /** All system properties used by <code>SimpleLog</code> start with this */
42      protected static final String SYSTEM_PREFIX = "org.apache.logging.log4j.simplelog.";
43  
44      private final PropertiesUtil props;
45  
46      /** Include the instance name in the log message? */
47      private final boolean showLogName;
48      
49      /**
50       * Include the short name (last component) of the logger in the log message. Defaults to true - otherwise we'll be
51       * lost in a flood of messages without knowing who sends them.
52       */
53      private final boolean showShortName;
54      /** Include the current time in the log message */
55      private final boolean showDateTime;
56      /** Include the ThreadContextMap in the log message */
57      private final boolean showContextMap;
58      /** The date and time format to use in the log message */
59      private final String dateTimeFormat;
60  
61      private final Level defaultLevel;
62  
63      private final PrintStream stream;
64  
65      private final ConcurrentMap<String, ExtendedLogger> loggers = new ConcurrentHashMap<>();
66  
67      public SimpleLoggerContext() {
68          props = new PropertiesUtil("log4j2.simplelog.properties");
69  
70          showContextMap = props.getBooleanProperty(SYSTEM_PREFIX + "showContextMap", false);
71          showLogName = props.getBooleanProperty(SYSTEM_PREFIX + "showlogname", false);
72          showShortName = props.getBooleanProperty(SYSTEM_PREFIX + "showShortLogname", true);
73          showDateTime = props.getBooleanProperty(SYSTEM_PREFIX + "showdatetime", false);
74          final String lvl = props.getStringProperty(SYSTEM_PREFIX + "level");
75          defaultLevel = Level.toLevel(lvl, Level.ERROR);
76  
77          dateTimeFormat = showDateTime ? props.getStringProperty(SimpleLoggerContext.SYSTEM_PREFIX + "dateTimeFormat",
78                  DEFAULT_DATE_TIME_FORMAT) : null;
79  
80          final String fileName = props.getStringProperty(SYSTEM_PREFIX + "logFile", "system.err");
81          PrintStream ps;
82          if ("system.err".equalsIgnoreCase(fileName)) {
83              ps = System.err;
84          } else if ("system.out".equalsIgnoreCase(fileName)) {
85              ps = System.out;
86          } else {
87              try {
88                  final FileOutputStream os = new FileOutputStream(fileName);
89                  ps = new PrintStream(os);
90              } catch (final FileNotFoundException fnfe) {
91                  ps = System.err;
92              }
93          }
94          this.stream = ps;
95      }
96  
97      @Override
98      public ExtendedLogger getLogger(final String name) {
99          return getLogger(name, null);
100     }
101 
102     @Override
103     public ExtendedLogger getLogger(final String name, final MessageFactory messageFactory) {
104         // Note: This is the only method where we add entries to the 'loggers' ivar.
105         // The loggers map key is the logger name plus the messageFactory FQCN.
106         String key = LoggerContextKey.create(name, messageFactory);
107         final ExtendedLogger extendedLogger = loggers.get(key);
108         if (extendedLogger != null) {
109             AbstractLogger.checkMessageFactory(extendedLogger, messageFactory);
110             return extendedLogger;
111         }
112         final SimpleLogger simpleLogger = new SimpleLogger(name, defaultLevel, showLogName, showShortName, showDateTime,
113                 showContextMap, dateTimeFormat, messageFactory, props, stream);
114         // If messageFactory was null then we need to pull it out of the logger now
115         key = LoggerContextKey.create(name, simpleLogger.getMessageFactory());
116         loggers.putIfAbsent(key, simpleLogger);
117         return loggers.get(key);
118     }
119 
120     @Override
121     public boolean hasLogger(final String name) {
122         return false;
123     }
124 
125     @Override
126     public boolean hasLogger(String name, MessageFactory messageFactory) {
127         return false;
128     }
129     
130     @Override
131     public boolean hasLogger(String name, Class<? extends MessageFactory> messageFactoryClass) {
132         return false;
133     }
134     
135     @Override
136     public Object getExternalContext() {
137         return null;
138     }
139 
140 }