001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.core.util;
018
019import java.nio.charset.Charset;
020import java.nio.charset.StandardCharsets;
021
022import org.apache.logging.log4j.util.PropertiesUtil;
023
024/**
025 * Log4j Constants.
026 */
027public final class Constants {
028
029    /**
030     * Name of the system property to use to identify the LogEvent factory.
031     */
032    public static final String LOG4J_LOG_EVENT_FACTORY = "Log4jLogEventFactory";
033
034    /**
035     * Name of the system property to use to identify the ContextSelector Class.
036     */
037    public static final String LOG4J_CONTEXT_SELECTOR = "Log4jContextSelector";
038
039    /**
040     * Property name for the default status (internal log4j logging) level to use if not specified in configuration.
041     */
042    public static final String LOG4J_DEFAULT_STATUS_LEVEL = "Log4jDefaultStatusLevel";
043
044    /**
045     * JNDI context name string literal.
046     */
047    public static final String JNDI_CONTEXT_NAME = "java:comp/env/log4j/context-name";
048
049    /**
050     * Line separator.
051     */
052    public static final String LINE_SEPARATOR = PropertiesUtil.getProperties().getStringProperty("line.separator",
053            "\n");
054
055    /**
056     * Number of milliseconds in a second.
057     */
058    public static final int MILLIS_IN_SECONDS = 1000;
059    
060    /**
061     * Equivalent to StandardCharsets.UTF_8.
062     * 
063     * @deprecated Use {@link StandardCharsets#UTF_8}. Will be removed in 2.5.
064     */
065    @Deprecated
066    public static final Charset UTF_8 = StandardCharsets.UTF_8;
067
068    /**
069     * Supports user request LOG4J2-898 to have the option to format a message in the background thread.
070     */
071    public static final boolean FORMAT_MESSAGES_IN_BACKGROUND = PropertiesUtil.getProperties().getBooleanProperty(
072            "log4j.format.msg.async", false);
073
074    /**
075     * Prevent class instantiation.
076     */
077    private Constants() {
078    }
079}