Source Code for Apache Log4j Web Servlet Containers

Apache Log4j Web Servlet Containers provides support for automatically enabling Log4j in Servlet containers.

Bytecode (Java 8) for Apache Log4j Web Servlet Containers is provided in a separate JAR file like log4j-web-2.14.1.jar.

Source Code files for Apache Log4j IOStreams are provided in both binary packge like apache-log4j-2.14.1-bin.zip and source package like apache-log4j-2.14.1-src.zip. You can download them at Apache Log4j Website.

You can also browse Source Code files for Apache Log4j Web Servlet Containers 2.14.1 below.

✍: FYIcenter.com

org/apache/logging/log4j/web/Log4jWebSupport.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache license, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the license for the specific language governing permissions and
 * limitations under the license.
 */
package org.apache.logging.log4j.web;

import org.apache.logging.log4j.spi.LoggerContext;

/**
 * Specifies an interface for setting and clearing a thread-bound {@link LoggerContext} in a Java EE web application.
 * Also defines constants for context parameter and attribute names. In most cases you will never need to use this
 * directly because the Log4j filter handles this task automatically. However, in async operations you should wrap
 * code that executes in separate threads with {@link #setLoggerContext} and {@link #clearLoggerContext}.
 *
 * <p>
 * You can obtain the instance of this for your web application by retrieving the {@link javax.servlet.ServletContext}
 * attribute named {@code org.apache.logging.log4j.core.web.Log4jWebSupport.INSTANCE}. If needed, you can also obtain
 * the {@link LoggerContext} instance for your web application by retrieving the {@code ServletContext} attribute named
 * {@code org.apache.logging.log4j.spi.LoggerContext.INSTANCE}.
 * </p>
 */
public interface Log4jWebSupport {
    /**
     * The {@link javax.servlet.ServletContext} parameter name for the name of the
     * {@link org.apache.logging.log4j.core.LoggerContext}.
     */
    String LOG4J_CONTEXT_NAME = "log4jContextName";

    /**
     * The {@link javax.servlet.ServletContext} parameter name for the location of the configuration.
     */
    String LOG4J_CONFIG_LOCATION = "log4jConfiguration";

    /**
     * The {@link javax.servlet.ServletContext} parameter name for the JNDI flag.
     */
    String IS_LOG4J_CONTEXT_SELECTOR_NAMED = "isLog4jContextSelectorNamed";

    /**
     * The {@link javax.servlet.ServletContext} parameter name for the flag that disables Log4j's auto-initialization
     * in Servlet 3.0+ web applications. Set a context parameter with this name to "true" to disable
     * auto-initialization.
     */
    String IS_LOG4J_AUTO_INITIALIZATION_DISABLED = "isLog4jAutoInitializationDisabled";

    /**
     * The {@link javax.servlet.ServletContext} parameter name for the flag that disables Log4j's auto-shutdown
     * in Servlet 3.0+ web applications. Set a context parameter with this name to "true" to disable
     * auto-shutdown.
     */
    String IS_LOG4J_AUTO_SHUTDOWN_DISABLED = "isLog4jAutoShutdownDisabled";

    /**
     * The attribute key for the {@link javax.servlet.ServletContext} attribute that the singleton support instance
     * is stored in.
     */
    String SUPPORT_ATTRIBUTE = Log4jWebSupport.class.getName() + ".INSTANCE";

    /**
     * The attribute key for the {@link javax.servlet.ServletContext} attribute that the {@link LoggerContext}
     * is stored in.
     */
    String CONTEXT_ATTRIBUTE = LoggerContext.class.getName() + ".INSTANCE";

    /**
     * Sets the logger context so that code executing afterwards can easily and quickly access loggers via
     * {@link org.apache.logging.log4j.LogManager#getLogger}.
     */
    void setLoggerContext();

    /**
     * Clears the logger context set up in {@link #setLoggerContext}.
     */
    void clearLoggerContext();

    /**
     * Sets the logger context by calling {@link #setLoggerContext}, executes the runnable argument, then clears the
     * logger context by calling {@link #clearLoggerContext}.
     *
     * @param runnable The runnable to execute wrapped with a configured logger context
     */
    void wrapExecution(Runnable runnable);
}

org/apache/logging/log4j/web/Log4jWebSupport.java

 

Or download all of them as a single archive file:

File name: log4j-web-2.14.1-sources.jar
File size: 30223 bytes
Release date: 2021-03-06
Download 

 

Source Code for Apache Log4j Tag Library

Source Code for Apache Log4j IOStreams

Downloading and Reviewing Apache Log4j Packages

⇑⇑ FAQ for Apache Log4j

2015-11-04, 8391👍, 0💬