001/** 002 * Logback: the reliable, generic, fast and flexible logging framework. 003 * Copyright (C) 1999-2015, QOS.ch. All rights reserved. 004 * 005 * This program and the accompanying materials are dual-licensed under 006 * either the terms of the Eclipse Public License v1.0 as published by 007 * the Eclipse Foundation 008 * 009 * or (per the licensee's choosing) 010 * 011 * under the terms of the GNU Lesser General Public License version 2.1 012 * as published by the Free Software Foundation. 013 */ 014package ch.qos.logback.core; 015 016import java.nio.charset.Charset; 017import java.nio.charset.StandardCharsets; 018 019public class CoreConstants { 020 021 final public static String DISABLE_SERVLET_CONTAINER_INITIALIZER_KEY = "logbackDisableServletContainerInitializer"; 022 final public static String STATUS_LISTENER_CLASS_KEY = "logback.statusListenerClass"; 023 final public static String SYSOUT = "SYSOUT"; 024 025 final public static String STDOUT = "STDOUT"; 026 027 /** 028 * Number of idle threads to retain in a context's executor service. 029 */ 030 public static final int CORE_POOL_SIZE = 0; 031 032 // In Java 21 and later the actual threads are assumed to be virtual 033 public static final int SCHEDULED_EXECUTOR_POOL_SIZE = 4; 034 035 /** 036 * Maximum number of threads to allow in a context's executor service. 037 */ 038 // if you need a different MAX_POOL_SIZE, please file create a github issue 039 // asking for a larger MAX_POOL_SIZE parameter. 040 public static final int MAX_POOL_SIZE = 32; 041 042 // Note that the line.separator property can be looked up even by 043 // applets. 044 public static final String LINE_SEPARATOR = System.getProperty("line.separator"); 045 public static final int LINE_SEPARATOR_LEN = LINE_SEPARATOR.length(); 046 047 public static final String CODES_URL = "http://logback.qos.ch/codes.html"; 048 public static final String MANUAL_URL_PREFIX = "http://logback.qos.ch/manual/"; 049 public static final String MORE_INFO_PREFIX = "For more information, please visit "; 050 051 /** 052 * The default context name. 053 */ 054 public static final String DEFAULT_CONTEXT_NAME = "default"; 055 /** 056 * Customized pattern conversion rules are stored under this key in the 057 * {@link Context} object store. 058 */ 059 public static final String PATTERN_RULE_REGISTRY = "PATTERN_RULE_REGISTRY"; 060 061 public static final String ISO8601_STR = "ISO8601"; 062 public static final String ISO8601_PATTERN = "yyyy-MM-dd HH:mm:ss,SSS"; 063 064 public static final String FILE_TIMESTAMP_PATTERN = "yyyy-MM-dd'T'HHmm"; 065 public static final String DAILY_DATE_PATTERN = "yyyy-MM-dd"; 066 067 /** 068 * Time format used in Common Log Format 069 */ 070 public static final String CLF_DATE_PATTERN = "dd/MMM/yyyy:HH:mm:ss Z"; 071 072 /** 073 * The key used in locating the evaluator map in context's object map. 074 */ 075 public static final String EVALUATOR_MAP = "EVALUATOR_MAP"; 076 077 /** 078 * Key used to locate a map Files used by FileAppender instances in context's 079 * object map. 080 * 081 * Said map consists of entries of the type (appender name, File option) 082 */ 083 public static final String FA_FILENAME_COLLISION_MAP = "FA_FILENAMES_MAP"; 084 085 /** 086 * Key used to locate a collision map for RollingFileAppender instances in 087 * context's object map. 088 * 089 * The collision map consists of entities of the type (appender name, 090 * FileNamePattern option) 091 */ 092 public static final String RFA_FILENAME_PATTERN_COLLISION_MAP = "RFA_FILENAME_PATTERN_COLLISION_MAP"; 093 094 /** 095 * By convention, we assume that the static method named "valueOf" taking a 096 * string argument can restore a given object from its string representation. 097 */ 098 public static final String VALUE_OF = "valueOf"; 099 100 /** 101 * An empty string. 102 */ 103 public static final String EMPTY_STRING = ""; 104 105 /** 106 * String value returned in case data is not available. 107 * 108 * For example, when caller information is not available this constant is used for file name, 109 * method name, etc. 110 */ 111 public static final String NA = "?"; 112 113 /** 114 * An empty string array. 115 */ 116 public static final String[] EMPTY_STRING_ARRAY = new String[] {}; 117 118 public static final Charset UTF_8_CHARSET = StandardCharsets.UTF_8; 119 120 /** 121 * An empty Class array. 122 */ 123 public static final Class<?>[] EMPTY_CLASS_ARRAY = new Class[] {}; 124 public static final String CAUSED_BY = "Caused by: "; 125 public static final String SUPPRESSED = "Suppressed: "; 126 public static final String WRAPPED_BY = "Wrapped by: "; 127 128 public static final char PERCENT_CHAR = '%'; 129 public static final char LEFT_PARENTHESIS_CHAR = '('; 130 public static final char RIGHT_PARENTHESIS_CHAR = ')'; 131 132 public static final char ESCAPE_CHAR = '\\'; 133 public static final char CURLY_LEFT = '{'; 134 public static final char CURLY_RIGHT = '}'; 135 public static final char COMMA_CHAR = ','; 136 public static final char DOUBLE_QUOTE_CHAR = '"'; 137 public static final char SINGLE_QUOTE_CHAR = '\''; 138 public static final char COLON_CHAR = ':'; 139 public static final char DASH_CHAR = '-'; 140 public static final String DEFAULT_VALUE_SEPARATOR = ":-"; 141 142 public static final String NULL_STR = "null"; 143 /** 144 * Number of rows before in an HTML table before, we close the table and create 145 * a new one 146 */ 147 public static final int TABLE_ROW_LIMIT = 10000; 148 149 // reset the ObjectOutputStream every OOS_RESET_FREQUENCY calls 150 // this avoids serious memory leaks 151 public static final int OOS_RESET_FREQUENCY = 70; 152 153 // See https://jakarta.ee/specifications/platform/8/platform-spec-8.html#a616 154 // there are the java:comp, java:module, java:app, java:global namespaces 155 public static final String JNDI_JAVA_NAMESPACE = "java:"; 156 157 // the max number of times an error should be reported 158 public static final int MAX_ERROR_COUNT = 4; 159 160 public static final char DOT = '.'; 161 public static final char TAB = '\t'; 162 public static final char DOLLAR = '$'; 163 164 public static final String SEE_FNP_NOT_SET = "See also " + CODES_URL + "#tbr_fnp_not_set"; 165 public static final String SEE_MISSING_INTEGER_TOKEN = "See also " + CODES_URL + "#sat_missing_integer_token"; 166 167 public static final String CONFIGURATION_WATCH_LIST = "CONFIGURATION_WATCH_LIST"; 168 public static final String CONFIGURATION_WATCH_LIST_RESET_X = "CONFIGURATION_WATCH_LIST_RESET"; 169 170 public static final String SAFE_JORAN_CONFIGURATION = "SAFE_JORAN_CONFIGURATION"; 171 public static final String XML_PARSING = "XML_PARSING"; 172 173 // Context Object name for the shutdown hook 174 public static final String SHUTDOWN_HOOK_THREAD = "SHUTDOWN_HOOK"; 175 176 /** 177 * The key under which the local host name is registered in the logger context. 178 */ 179 public static final String HOSTNAME_KEY = "HOSTNAME"; 180 181 public static final String UNKNOWN_LOCALHOST = "UNKNOWN_LOCALHOST"; 182 183 /** 184 * The key under which the current context name is registered in the logger 185 * context. 186 */ 187 public static final String CONTEXT_NAME_KEY = "CONTEXT_NAME"; 188 189 public static final int BYTES_PER_INT = 4; 190 public static final long MILLIS_IN_ONE_SECOND = 1000; 191 public static final long MILLIS_IN_ONE_MINUTE = MILLIS_IN_ONE_SECOND * 60; 192 public static final long MILLIS_IN_ONE_HOUR = MILLIS_IN_ONE_MINUTE * 60; 193 public static final long MILLIS_IN_ONE_DAY = MILLIS_IN_ONE_HOUR * 24; 194 public static final long MILLIS_IN_ONE_WEEK = MILLIS_IN_ONE_DAY * 7; 195 196 /** 197 * The number of seconds to wait for compression jobs to finish. 198 */ 199 public static final int SECONDS_TO_WAIT_FOR_COMPRESSION_JOBS = 30; 200 201 public static final String CONTEXT_SCOPE_VALUE = "context"; 202 203 public static final String RESET_MSG_PREFIX = "Will reset and reconfigure context "; 204 205 public static final String JNDI_COMP_PREFIX = "java:comp/env"; 206 207 public static final String UNDEFINED_PROPERTY_SUFFIX = "_IS_UNDEFINED"; 208 209 public static final String LEFT_ACCOLADE = new String(new char[] { CURLY_LEFT }); 210 public static final String RIGHT_ACCOLADE = new String(new char[] { CURLY_RIGHT }); 211 public static final long UNBOUNDED_TOTAL_SIZE_CAP = 0; 212 213 /** 214 * If Rolling 215 */ 216 public static final int UNBOUNDED_HISTORY = 0; 217 218 /** 219 * Replaced by {@link CoreConstants#UNBOUNDED_HISTORY} with the same identical value. 220 221 * @deprecated 222 * @see #UNBOUNDED_HISTORY 223 */ 224 public static final int UNBOUND_HISTORY = UNBOUNDED_HISTORY; 225 226 //public static final String RECONFIGURE_ON_CHANGE_TASK = "RECONFIGURE_ON_CHANGE_TASK"; 227 public static final String SIZE_AND_TIME_BASED_FNATP_IS_DEPRECATED = "SizeAndTimeBasedFNATP is deprecated. Use SizeAndTimeBasedRollingPolicy instead"; 228 229 public static final String LOGBACK_CLASSIC_VERSION_MESSAGE = "This is logback-classic version "; 230 public static final char JSON_LINE_SEPARATOR = '\n'; 231 final public static String MODEL_CONFIG_FILE_EXTENSION = ".scmo"; 232}