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.core.util;
18  
19  import java.nio.charset.Charset;
20  import java.nio.charset.StandardCharsets;
21  
22  import org.apache.logging.log4j.util.PropertiesUtil;
23  
24  /**
25   * Log4j Constants.
26   */
27  public final class Constants {
28  
29      /**
30       * Name of the system property to use to identify the LogEvent factory.
31       */
32      public static final String LOG4J_LOG_EVENT_FACTORY = "Log4jLogEventFactory";
33  
34      /**
35       * Name of the system property to use to identify the ContextSelector Class.
36       */
37      public static final String LOG4J_CONTEXT_SELECTOR = "Log4jContextSelector";
38  
39      /**
40       * Property name for the default status (internal log4j logging) level to use if not specified in configuration.
41       */
42      public static final String LOG4J_DEFAULT_STATUS_LEVEL = "Log4jDefaultStatusLevel";
43  
44      /**
45       * JNDI context name string literal.
46       */
47      public static final String JNDI_CONTEXT_NAME = "java:comp/env/log4j/context-name";
48  
49      /**
50       * Line separator.
51       */
52      public static final String LINE_SEPARATOR = PropertiesUtil.getProperties().getStringProperty("line.separator",
53              "\n");
54  
55      /**
56       * Number of milliseconds in a second.
57       */
58      public static final int MILLIS_IN_SECONDS = 1000;
59      
60      /**
61       * Equivalent to StandardCharsets.UTF_8.
62       * 
63       * @deprecated Use {@link StandardCharsets#UTF_8}. Will be removed in 2.5.
64       */
65      @Deprecated
66      public static final Charset UTF_8 = StandardCharsets.UTF_8;
67  
68      /**
69       * Supports user request LOG4J2-898 to have the option to format a message in the background thread.
70       */
71      public static final boolean FORMAT_MESSAGES_IN_BACKGROUND = PropertiesUtil.getProperties().getBooleanProperty(
72              "log4j.format.msg.async", false);
73  
74      /**
75       * Prevent class instantiation.
76       */
77      private Constants() {
78      }
79  }