2 * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3 * Copyright (C) $$Year-Rel$$ The Jalview Authors
5 * This file is part of Jalview.
7 * Jalview is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation, either version 3
10 * of the License, or (at your option) any later version.
12 * Jalview is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty
14 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 * PURPOSE. See the GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Jalview. If not, see <http://www.gnu.org/licenses/>.
19 * The Jalview Authors are detailed in the 'AUTHORS' file.
25 import org.apache.logging.log4j.Level;
26 import org.apache.logging.log4j.LogManager;
27 import org.apache.logging.log4j.Logger;
28 import org.apache.logging.log4j.core.Appender;
29 import org.apache.logging.log4j.core.Filter;
30 import org.apache.logging.log4j.core.Layout;
31 import org.apache.logging.log4j.core.LoggerContext;
32 import org.apache.logging.log4j.core.appender.ConsoleAppender;
33 import org.apache.logging.log4j.core.config.Configuration;
34 import org.apache.logging.log4j.core.config.ConfigurationFactory;
35 import org.apache.logging.log4j.core.config.Configurator;
36 import org.apache.logging.log4j.core.config.LoggerConfig;
37 import org.apache.logging.log4j.core.config.builder.api.AppenderComponentBuilder;
38 import org.apache.logging.log4j.core.config.builder.api.ConfigurationBuilder;
39 import org.apache.logging.log4j.core.config.builder.api.FilterComponentBuilder;
40 import org.apache.logging.log4j.core.config.builder.api.LayoutComponentBuilder;
41 import org.apache.logging.log4j.core.config.builder.impl.BuiltConfiguration;
42 import org.apache.logging.log4j.core.filter.ThresholdFilter;
43 import org.apache.logging.log4j.core.layout.PatternLayout;
45 import jalview.log.JLogger;
46 import jalview.log.JalviewAppender;
51 public final static String SIMPLE_PATTERN = "%level - %m%n";
53 private static boolean init = false;
55 public static boolean isInit()
60 public static Level log4jLevel(JLogger.LogLevel loglevel)
62 return Level.toLevel(loglevel.toString());
65 public static void init(JLogger.LogLevel myLevel)
67 init(log4jLevel(myLevel));
70 public static void init(Level myLevel)
76 // configure the root logger to stderr
77 ConfigurationBuilder<BuiltConfiguration> configBuilder = Log4j
78 .getConfigurationBuilder();
80 configBuilder.setStatusLevel(Level.WARN);
82 String consoleLoggerName = "STDERR";
83 AppenderComponentBuilder appenderBuilder = configBuilder
84 .newAppender(consoleLoggerName, "Console");
85 appenderBuilder.addAttribute("target",
86 ConsoleAppender.Target.SYSTEM_ERR);
87 appenderBuilder.add(Log4j.getSimpleLayoutBuilder());
88 appenderBuilder.add(Log4j.getThresholdFilterBuilder());
89 configBuilder.add(appenderBuilder);
91 configBuilder.add(configBuilder.newRootLogger(myLevel)
92 .add(configBuilder.newAppenderRef(consoleLoggerName)));
94 Configurator.initialize(configBuilder.build());
100 .errPrintln("Problems initializing the log4j system\n");
101 e.printStackTrace(System.err);
105 public static Logger getLogger(String name)
107 return getLogger(name, Level.INFO);
110 public static Logger getLogger(String name, JLogger.LogLevel loglevel)
112 return getLogger(name, log4jLevel(loglevel));
115 public static Logger getLogger(String name, Level level)
117 Logger logger = LogManager.getLogger(name);
118 Log4j.setLevel(logger, level);
122 public static ConfigurationBuilder<BuiltConfiguration> getConfigurationBuilder()
124 return ConfigurationFactory.newConfigurationBuilder();
127 public static Layout getSimpleLayout()
129 return PatternLayout.newBuilder().withPattern(SIMPLE_PATTERN).build();
132 public static LayoutComponentBuilder getSimpleLayoutBuilder()
134 return getConfigurationBuilder().newLayout("PatternLayout")
135 .addAttribute("pattern", Log4j.SIMPLE_PATTERN);
138 public static Filter getThresholdFilter(Level level)
140 return ThresholdFilter.createFilter(level, Filter.Result.ACCEPT,
141 Filter.Result.NEUTRAL);
144 public static FilterComponentBuilder getThresholdFilterBuilder()
146 return getConfigurationBuilder().newFilter("ThresholdFilter",
147 Filter.Result.ACCEPT, Filter.Result.NEUTRAL);
150 public static void setLevel(Logger logger, JLogger.LogLevel loglevel)
152 setLevel(logger, log4jLevel(loglevel));
155 public static void setLevel(Logger logger, Level level)
157 if (!Platform.isJS())
159 LoggerContext context = (LoggerContext) LogManager.getContext(false);
160 Configuration config = context.getConfiguration();
161 LoggerConfig loggerConfig = config.getLoggerConfig(logger.getName());
162 loggerConfig.setLevel(level);
164 Map<String, Appender> appenders = config.getAppenders();
166 Appender jappender = config.getAppender(JalviewAppender.NAME);
168 context.updateLoggers();
172 public static void setRootLevel(JLogger.LogLevel loglevel)
174 setRootLevel(log4jLevel(loglevel));
177 public static void setRootLevel(Level level)
179 setLevel(LogManager.getRootLogger(), level);
182 public static Appender getAppender(String name)
184 LoggerContext context = (LoggerContext) LogManager.getContext(false);
185 Configuration config = context.getConfiguration();
186 Map<String, Appender> appenders = config.getAppenders();
187 return appenders.get(name);
190 public static void addAppender(Logger logger, Logger logger2,
193 LoggerContext context = (LoggerContext) LogManager.getContext(false);
194 Configuration config = context.getConfiguration();
195 LoggerConfig logger2Config = config.getLoggerConfig(logger2.getName());
196 Map<String, Appender> logger2AppendersMap = logger2Config
198 Appender appender = logger2AppendersMap.get(name2);
199 addAppender(logger, appender);
200 context.updateLoggers();
203 public static void addAppender(Logger logger, Appender appender)
205 if (appender == null)
207 LoggerContext context = (LoggerContext) LogManager.getContext(false);
208 Configuration config = context.getConfiguration();
209 LoggerConfig loggerConfig = config.getLoggerConfig(logger.getName());
210 if (loggerConfig == null)
213 Level level = loggerConfig.getLevel();
215 config.addAppender(appender);
216 loggerConfig.addAppender(appender, null, null);
218 context.updateLoggers();
221 public static void addAppenderToRootLogger(Appender appender)
223 Log4j.addAppender(LogManager.getRootLogger(), appender);