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
    18  package org.apache.log4j.helpers;
    19
    20
    21  /**
    22   * Constants used internally throughout log4j.
    23   */
    24  public interface Constants {
    25
    26      /**
    27       * log4j package name string literal.
    28       */
    29      String LOG4J_PACKAGE_NAME = "org.apache.log4j";
    30
    31      /**
    32       * The name of the default repository is "default" (without the quotes).
    33       */
    34      String DEFAULT_REPOSITORY_NAME = "default";
    35
    36      /**
    37       * application string literal.
    38       */
    39      String APPLICATION_KEY = "application";
    40      /**
    41       * hostname string literal.
    42       */
    43      String HOSTNAME_KEY = "hostname";
    44      /**
    45       * receiver string literal.
    46       */
    47      String RECEIVER_NAME_KEY = "receiver";
    48      /**
    49       * group string literal.
    50       */
    51      String GROUP_KEY = "group";
    52      /**
    53       * log4jid string literal.
    54       */
    55      String LOG4J_ID_KEY = "log4jid";
    56      /**
    57       * time stamp pattern string literal.
    58       */
    59      String TIMESTAMP_RULE_FORMAT = "yyyy/MM/dd HH:mm:ss";
    60
    61      /**
    62       * The default property file name for automatic configuration.
    63       */
    64      String DEFAULT_CONFIGURATION_FILE = "log4j.properties";
    65      /**
    66       * The default XML configuration file name for automatic configuration.
    67       */
    68      String DEFAULT_XML_CONFIGURATION_FILE = "log4j.xml";
    69      /**
    70       * log4j.configuration string literal.
    71       */
    72      String DEFAULT_CONFIGURATION_KEY = "log4j.configuration";
    73      /**
    74       * log4j.configuratorClass string literal.
    75       */
    76      String CONFIGURATOR_CLASS_KEY = "log4j.configuratorClass";
    77
    78      /**
    79       * JNDI context name string literal.
    80       */
    81      String JNDI_CONTEXT_NAME = "java:comp/env/log4j/context-name";
    82
    83      /**
    84       * TEMP_LIST_APPENDER string literal.
    85       */
    86      String TEMP_LIST_APPENDER_NAME = "TEMP_LIST_APPENDER";
    87      /**
    88       * TEMP_CONSOLE_APPENDER string literal.
    89       */
    90      String TEMP_CONSOLE_APPENDER_NAME = "TEMP_CONSOLE_APPENDER";
    91      /**
    92       * Codes URL string literal.
    93       */
    94      String CODES_HREF =
    95          "http://logging.apache.org/log4j/docs/codes.html";
    96
    97
    98      /**
    99       * ABSOLUTE string literal.
    100      */
    101     String ABSOLUTE_FORMAT = "ABSOLUTE";
    102     /**
    103      * SimpleTimePattern for ABSOLUTE.
    104      */
    105     String ABSOLUTE_TIME_PATTERN = "HH:mm:ss,SSS";
    106
    107     /**
    108      * SimpleTimePattern for ABSOLUTE.
    109      */
    110     String SIMPLE_TIME_PATTERN = "HH:mm:ss";
    111
    112     /**
    113      * DATE string literal.
    114      */
    115     String DATE_AND_TIME_FORMAT = "DATE";
    116     /**
    117      * SimpleTimePattern for DATE.
    118      */
    119     String DATE_AND_TIME_PATTERN = "dd MMM yyyy HH:mm:ss,SSS";
    120
    121     /**
    122      * ISO8601 string literal.
    123      */
    124     String ISO8601_FORMAT = "ISO8601";
    125     /**
    126      * SimpleTimePattern for ISO8601.
    127      */
    128     String ISO8601_PATTERN = "yyyy-MM-dd HH:mm:ss,SSS";
    129 }