log4j-jakarta-web/src/main/java/org/apache/logging/log4j/web/WebLoggerContextUtils.java [36:139]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - public final class WebLoggerContextUtils { private WebLoggerContextUtils() {} private static final Lock WEB_SUPPORT_LOOKUP = new ReentrantLock(); private static final String SERVLET_CONTEXT = "__SERVLET_CONTEXT__"; /** * Finds the main {@link org.apache.logging.log4j.core.LoggerContext} configured for the given ServletContext. * * @param servletContext the ServletContext to locate a LoggerContext for * @return the LoggerContext for the given ServletContext * @since 2.0.1 */ public static LoggerContext getWebLoggerContext(final ServletContext servletContext) { return (LoggerContext) servletContext.getAttribute(Log4jWebSupport.CONTEXT_ATTRIBUTE); } /** * Finds the main {@link org.apache.logging.log4j.core.LoggerContext} configured for the given ServletContext. * * @param servletContext the ServletContext to locate a LoggerContext for * @return the LoggerContext for the given ServletContext or {@code null} if none was set * @throws java.lang.IllegalStateException if no LoggerContext could be found on the given ServletContext * @since 2.0.1 */ public static LoggerContext getRequiredWebLoggerContext(final ServletContext servletContext) { final LoggerContext loggerContext = getWebLoggerContext(servletContext); if (loggerContext == null) { throw new IllegalStateException( "No LoggerContext found in ServletContext attribute " + Log4jWebSupport.CONTEXT_ATTRIBUTE); } return loggerContext; } /** * Finds or initializes the {@link org.apache.logging.log4j.web.Log4jWebLifeCycle} singleton for the given * ServletContext. * * @param servletContext the ServletContext to get the Log4jWebLifeCycle for * @return the Log4jWebLifeCycle for the given ServletContext * @since 2.0.1 */ public static Log4jWebLifeCycle getWebLifeCycle(final ServletContext servletContext) { WEB_SUPPORT_LOOKUP.lock(); try { Log4jWebLifeCycle webLifeCycle = (Log4jWebLifeCycle) servletContext.getAttribute(Log4jWebSupport.SUPPORT_ATTRIBUTE); if (webLifeCycle == null) { webLifeCycle = Log4jWebInitializerImpl.initialize(servletContext); } return webLifeCycle; } finally { WEB_SUPPORT_LOOKUP.unlock(); } } /** * Wraps a Runnable instance by setting its thread context {@link org.apache.logging.log4j.core.LoggerContext} * before execution and clearing it after execution. * * @param servletContext the ServletContext to locate a LoggerContext for * @param runnable the Runnable to wrap execution for * @return a wrapped Runnable * @since 2.0.1 */ public static Runnable wrapExecutionContext(final ServletContext servletContext, final Runnable runnable) { return () -> { final Log4jWebSupport webSupport = getWebLifeCycle(servletContext); webSupport.setLoggerContext(); try { runnable.run(); } finally { webSupport.clearLoggerContext(); } }; } public static Map.Entry createExternalEntry(final ServletContext servletContext) { return new AbstractMap.SimpleEntry<>(SERVLET_CONTEXT, servletContext); } public static void setServletContext(LoggerContext lc, ServletContext servletContext) { if (lc != null) { lc.putObject(SERVLET_CONTEXT, servletContext); } } /** * Gets the current {@link ServletContext} if it has already been assigned to a LoggerContext's external context. * * @return the current ServletContext attached to a LoggerContext or {@code null} if none could be found * @since 2.1 */ public static ServletContext getServletContext() { org.apache.logging.log4j.spi.LoggerContext lc = ContextAnchor.THREAD_CONTEXT.get(); if (lc == null) { lc = LogManager.getContext(false); } final Object obj = lc != null ? lc.getObject(SERVLET_CONTEXT) : null; if (obj instanceof ServletContext) { return (ServletContext) obj; } return null; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - log4j-web/src/main/java/org/apache/logging/log4j/web/WebLoggerContextUtils.java [36:139]: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - public final class WebLoggerContextUtils { private WebLoggerContextUtils() {} private static final Lock WEB_SUPPORT_LOOKUP = new ReentrantLock(); private static final String SERVLET_CONTEXT = "__SERVLET_CONTEXT__"; /** * Finds the main {@link org.apache.logging.log4j.core.LoggerContext} configured for the given ServletContext. * * @param servletContext the ServletContext to locate a LoggerContext for * @return the LoggerContext for the given ServletContext * @since 2.0.1 */ public static LoggerContext getWebLoggerContext(final ServletContext servletContext) { return (LoggerContext) servletContext.getAttribute(Log4jWebSupport.CONTEXT_ATTRIBUTE); } /** * Finds the main {@link org.apache.logging.log4j.core.LoggerContext} configured for the given ServletContext. * * @param servletContext the ServletContext to locate a LoggerContext for * @return the LoggerContext for the given ServletContext or {@code null} if none was set * @throws java.lang.IllegalStateException if no LoggerContext could be found on the given ServletContext * @since 2.0.1 */ public static LoggerContext getRequiredWebLoggerContext(final ServletContext servletContext) { final LoggerContext loggerContext = getWebLoggerContext(servletContext); if (loggerContext == null) { throw new IllegalStateException( "No LoggerContext found in ServletContext attribute " + Log4jWebSupport.CONTEXT_ATTRIBUTE); } return loggerContext; } /** * Finds or initializes the {@link org.apache.logging.log4j.web.Log4jWebLifeCycle} singleton for the given * ServletContext. * * @param servletContext the ServletContext to get the Log4jWebLifeCycle for * @return the Log4jWebLifeCycle for the given ServletContext * @since 2.0.1 */ public static Log4jWebLifeCycle getWebLifeCycle(final ServletContext servletContext) { WEB_SUPPORT_LOOKUP.lock(); try { Log4jWebLifeCycle webLifeCycle = (Log4jWebLifeCycle) servletContext.getAttribute(Log4jWebSupport.SUPPORT_ATTRIBUTE); if (webLifeCycle == null) { webLifeCycle = Log4jWebInitializerImpl.initialize(servletContext); } return webLifeCycle; } finally { WEB_SUPPORT_LOOKUP.unlock(); } } /** * Wraps a Runnable instance by setting its thread context {@link org.apache.logging.log4j.core.LoggerContext} * before execution and clearing it after execution. * * @param servletContext the ServletContext to locate a LoggerContext for * @param runnable the Runnable to wrap execution for * @return a wrapped Runnable * @since 2.0.1 */ public static Runnable wrapExecutionContext(final ServletContext servletContext, final Runnable runnable) { return () -> { final Log4jWebSupport webSupport = getWebLifeCycle(servletContext); webSupport.setLoggerContext(); try { runnable.run(); } finally { webSupport.clearLoggerContext(); } }; } public static Map.Entry createExternalEntry(final ServletContext servletContext) { return new AbstractMap.SimpleEntry<>(SERVLET_CONTEXT, servletContext); } public static void setServletContext(LoggerContext lc, ServletContext servletContext) { if (lc != null) { lc.putObject(SERVLET_CONTEXT, servletContext); } } /** * Gets the current {@link ServletContext} if it has already been assigned to a LoggerContext's external context. * * @return the current ServletContext attached to a LoggerContext or {@code null} if none could be found * @since 2.1 */ public static ServletContext getServletContext() { org.apache.logging.log4j.spi.LoggerContext lc = ContextAnchor.THREAD_CONTEXT.get(); if (lc == null) { lc = LogManager.getContext(false); } final Object obj = lc != null ? lc.getObject(SERVLET_CONTEXT) : null; if (obj instanceof ServletContext) { return (ServletContext) obj; } return null; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -