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