blob: 20d64ad1a9eb8426042c3fd1da73a023d316cdc1 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Log4jContextFactory (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.apache.logging.log4j.core.impl, class: Log4jContextFactory">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-declaration-page">
<script type="text/javascript">var evenRowColor = "even-row-color";
var oddRowColor = "odd-row-color";
var tableTab = "table-tab";
var activeTableTab = "active-table-tab";
var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="nav-bar-cell1-rev">Class</li>
<li><a href="class-use/Log4jContextFactory.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.logging.log4j.core.impl</a></div>
<h1 title="Class Log4jContextFactory" class="title">Class Log4jContextFactory</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance">org.apache.logging.log4j.core.impl.Log4jContextFactory</div>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Implemented Interfaces:</dt>
<dd><code><a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a></code>, <code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Log4jContextFactory</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
implements <a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a>, <a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a></span></div>
<div class="block">Factory to locate a ContextSelector and then load a LoggerContext.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.logging.log4j.core.util.ShutdownCallbackRegistry">Fields inherited from interface&nbsp;org.apache.logging.log4j.core.util.<a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a></h3>
<code><a href="../util/ShutdownCallbackRegistry.html#SHUTDOWN_CALLBACK_REGISTRY">SHUTDOWN_CALLBACK_REGISTRY</a>, <a href="../util/ShutdownCallbackRegistry.html#SHUTDOWN_HOOK_MARKER">SHUTDOWN_HOOK_MARKER</a></code></div>
</section>
</li>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<li>
<section class="constructor-summary" id="constructor-summary">
<h2>Constructor Summary</h2>
<div class="caption"><span>Constructors</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">Log4jContextFactory</a>()</code></div>
<div class="col-last even-row-color">
<div class="block">Initializes the ContextSelector from system property <a href="../util/Constants.html#LOG4J_CONTEXT_SELECTOR"><code>Constants.LOG4J_CONTEXT_SELECTOR</code></a>.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.selector.ContextSelector)" class="member-name-link">Log4jContextFactory</a><wbr>(<a href="../selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a>&nbsp;selector)</code></div>
<div class="col-last odd-row-color">
<div class="block">Initializes this factory's ContextSelector with the specified selector.</div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.selector.ContextSelector,org.apache.logging.log4j.core.util.ShutdownCallbackRegistry)" class="member-name-link">Log4jContextFactory</a><wbr>(<a href="../selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a>&nbsp;selector,
<a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a>&nbsp;shutdownCallbackRegistry)</code></div>
<div class="col-last even-row-color">
<div class="block">Constructs a Log4jContextFactory using the provided ContextSelector and ShutdownRegistrationStrategy.</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.logging.log4j.core.util.ShutdownCallbackRegistry)" class="member-name-link">Log4jContextFactory</a><wbr>(<a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a>&nbsp;shutdownCallbackRegistry)</code></div>
<div class="col-last odd-row-color">
<div class="block">Constructs a Log4jContextFactory using the ContextSelector from <a href="../util/Constants.html#LOG4J_CONTEXT_SELECTOR"><code>Constants.LOG4J_CONTEXT_SELECTOR</code></a>
and the provided ShutdownRegistrationStrategy.</div>
</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
<div id="method-summary-table.tabpanel" role="tabpanel">
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/Cancellable.html" title="interface in org.apache.logging.log4j.core.util">Cancellable</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#addShutdownCallback(java.lang.Runnable)" class="member-name-link">addShutdownCallback</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;callback)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Adds a Runnable shutdown callback to this class.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Loads the LoggerContext using the ContextSelector.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,java.net.URI,java.lang.String)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;configLocation,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Loads the LoggerContext using the ContextSelector.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,java.util.List,java.lang.String)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&gt;&nbsp;configLocations,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Loads the LoggerContext using the ContextSelector using the provided Configuration</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,org.apache.logging.log4j.core.config.ConfigurationSource)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="../config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a>&nbsp;source)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Loads the LoggerContext using the ContextSelector.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getContext(java.lang.String,java.lang.ClassLoader,java.util.Map.Entry,boolean,java.net.URI,java.lang.String)" class="member-name-link">getContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;entry,
boolean&nbsp;currentContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;configLocation,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSelector()" class="member-name-link">getSelector</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the ContextSelector.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getShutdownCallbackRegistry()" class="member-name-link">getShutdownCallbackRegistry</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Returns the ShutdownCallbackRegistry</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasContext(java.lang.String,java.lang.ClassLoader,boolean)" class="member-name-link">hasContext</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
boolean&nbsp;currentContext)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Checks to see if a LoggerContext is installed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isClassLoaderDependent()" class="member-name-link">isClassLoaderDependent</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isShutdownHookEnabled()" class="member-name-link">isShutdownHookEnabled</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#removeContext(org.apache.logging.log4j.spi.LoggerContext)" class="member-name-link">removeContext</a><wbr>(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContext</a>&nbsp;context)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Removes knowledge of a LoggerContext.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#shutdown(java.lang.String,java.lang.ClassLoader,boolean,boolean)" class="member-name-link">shutdown</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
boolean&nbsp;currentContext,
boolean&nbsp;allContexts)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<li>
<section class="constructor-details" id="constructor-detail">
<h2>Constructor Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="&lt;init&gt;()">
<h3>Log4jContextFactory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Log4jContextFactory</span>()</div>
<div class="block">Initializes the ContextSelector from system property <a href="../util/Constants.html#LOG4J_CONTEXT_SELECTOR"><code>Constants.LOG4J_CONTEXT_SELECTOR</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.logging.log4j.core.selector.ContextSelector)">
<h3>Log4jContextFactory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Log4jContextFactory</span><wbr><span class="parameters">(<a href="../selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a>&nbsp;selector)</span></div>
<div class="block">Initializes this factory's ContextSelector with the specified selector.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>selector</code> - the selector to use</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.logging.log4j.core.util.ShutdownCallbackRegistry)">
<h3>Log4jContextFactory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Log4jContextFactory</span><wbr><span class="parameters">(<a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a>&nbsp;shutdownCallbackRegistry)</span></div>
<div class="block">Constructs a Log4jContextFactory using the ContextSelector from <a href="../util/Constants.html#LOG4J_CONTEXT_SELECTOR"><code>Constants.LOG4J_CONTEXT_SELECTOR</code></a>
and the provided ShutdownRegistrationStrategy.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>shutdownCallbackRegistry</code> - the ShutdownRegistrationStrategy to use</dd>
<dt>Since:</dt>
<dd>2.1</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(org.apache.logging.log4j.core.selector.ContextSelector,org.apache.logging.log4j.core.util.ShutdownCallbackRegistry)">
<h3>Log4jContextFactory</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">Log4jContextFactory</span><wbr><span class="parameters">(<a href="../selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a>&nbsp;selector,
<a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a>&nbsp;shutdownCallbackRegistry)</span></div>
<div class="block">Constructs a Log4jContextFactory using the provided ContextSelector and ShutdownRegistrationStrategy.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>selector</code> - the selector to use</dd>
<dd><code>shutdownCallbackRegistry</code> - the ShutdownRegistrationStrategy to use</dd>
<dt>Since:</dt>
<dd>2.1</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean)">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span>&nbsp;<span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext)</span></div>
<div class="block">Loads the LoggerContext using the ContextSelector.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
<dt>Parameters:</dt>
<dd><code>fqcn</code> - The fully qualified class name of the caller.</dd>
<dd><code>loader</code> - The ClassLoader to use or null.</dd>
<dd><code>currentContext</code> - If true returns the current Context, if false returns the Context appropriate
for the caller if a more appropriate Context can be determined.</dd>
<dd><code>externalContext</code> - An external context (such as a ServletContext) to be associated with the LoggerContext.</dd>
<dt>Returns:</dt>
<dd>The LoggerContext.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,org.apache.logging.log4j.core.config.ConfigurationSource)">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span>&nbsp;<span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="../config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a>&nbsp;source)</span></div>
<div class="block">Loads the LoggerContext using the ContextSelector.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fqcn</code> - The fully qualified class name of the caller.</dd>
<dd><code>loader</code> - The ClassLoader to use or null.</dd>
<dd><code>externalContext</code> - An external context (such as a ServletContext) to be associated with the LoggerContext.</dd>
<dd><code>currentContext</code> - If true returns the current Context, if false returns the Context appropriate
for the caller if a more appropriate Context can be determined.</dd>
<dd><code>source</code> - The configuration source.</dd>
<dt>Returns:</dt>
<dd>The LoggerContext.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,org.apache.logging.log4j.core.config.Configuration)">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span>&nbsp;<span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration)</span></div>
<div class="block">Loads the LoggerContext using the ContextSelector using the provided Configuration</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>fqcn</code> - The fully qualified class name of the caller.</dd>
<dd><code>loader</code> - The ClassLoader to use or null.</dd>
<dd><code>externalContext</code> - An external context (such as a ServletContext) to be associated with the LoggerContext.</dd>
<dd><code>currentContext</code> - If true returns the current Context, if false returns the Context appropriate
for the caller if a more appropriate Context can be determined.</dd>
<dd><code>configuration</code> - The Configuration.</dd>
<dt>Returns:</dt>
<dd>The LoggerContext.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,java.net.URI,java.lang.String)">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span>&nbsp;<span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;configLocation,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
<div class="block">Loads the LoggerContext using the ContextSelector.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html#getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,java.net.URI,java.lang.String)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">getContext</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
<dt>Parameters:</dt>
<dd><code>fqcn</code> - The fully qualified class name of the caller.</dd>
<dd><code>loader</code> - The ClassLoader to use or null.</dd>
<dd><code>externalContext</code> - An external context (such as a ServletContext) to be associated with the LoggerContext.</dd>
<dd><code>currentContext</code> - If true returns the current Context, if false returns the Context appropriate
for the caller if a more appropriate Context can be determined.</dd>
<dd><code>configLocation</code> - The location of the configuration for the LoggerContext (or null).</dd>
<dt>Returns:</dt>
<dd>The LoggerContext.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getContext(java.lang.String,java.lang.ClassLoader,java.util.Map.Entry,boolean,java.net.URI,java.lang.String)">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span>&nbsp;<span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.Entry.html" title="class or interface in java.util" class="external-link">Map.Entry</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;entry,
boolean&nbsp;currentContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&nbsp;configLocation,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
</section>
</li>
<li>
<section class="detail" id="getContext(java.lang.String,java.lang.ClassLoader,java.lang.Object,boolean,java.util.List,java.lang.String)">
<h3>getContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></span>&nbsp;<span class="element-name">getContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&nbsp;externalContext,
boolean&nbsp;currentContext,
<a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html" title="class or interface in java.net" class="external-link">URI</a>&gt;&nbsp;configLocations,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span></div>
</section>
</li>
<li>
<section class="detail" id="shutdown(java.lang.String,java.lang.ClassLoader,boolean,boolean)">
<h3>shutdown</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">shutdown</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
boolean&nbsp;currentContext,
boolean&nbsp;allContexts)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html#shutdown(java.lang.String,java.lang.ClassLoader,boolean,boolean)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">shutdown</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="hasContext(java.lang.String,java.lang.ClassLoader,boolean)">
<h3>hasContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">hasContext</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;fqcn,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html" title="class or interface in java.lang" class="external-link">ClassLoader</a>&nbsp;loader,
boolean&nbsp;currentContext)</span></div>
<div class="block">Checks to see if a LoggerContext is installed.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html#hasContext(java.lang.String,java.lang.ClassLoader,boolean)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">hasContext</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
<dt>Parameters:</dt>
<dd><code>fqcn</code> - The fully qualified class name of the caller.</dd>
<dd><code>loader</code> - The ClassLoader to use or null.</dd>
<dd><code>currentContext</code> - If true returns the current Context, if false returns the Context appropriate
for the caller if a more appropriate Context can be determined.</dd>
<dt>Returns:</dt>
<dd>true if a LoggerContext has been installed, false otherwise.</dd>
<dt>Since:</dt>
<dd>3.0</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getSelector()">
<h3>getSelector</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></span>&nbsp;<span class="element-name">getSelector</span>()</div>
<div class="block">Returns the ContextSelector.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The ContextSelector.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getShutdownCallbackRegistry()">
<h3>getShutdownCallbackRegistry</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a></span>&nbsp;<span class="element-name">getShutdownCallbackRegistry</span>()</div>
<div class="block">Returns the ShutdownCallbackRegistry</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>the ShutdownCallbackRegistry</dd>
<dt>Since:</dt>
<dd>2.4</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="removeContext(org.apache.logging.log4j.spi.LoggerContext)">
<h3>removeContext</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">removeContext</span><wbr><span class="parameters">(<a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContext.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContext</a>&nbsp;context)</span></div>
<div class="block">Removes knowledge of a LoggerContext.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html#removeContext(org.apache.logging.log4j.spi.LoggerContext)" title="class or interface in org.apache.logging.log4j.spi" class="external-link">removeContext</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
<dt>Parameters:</dt>
<dd><code>context</code> - The context to remove.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isClassLoaderDependent()">
<h3>isClassLoaderDependent</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isClassLoaderDependent</span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html#isClassLoaderDependent()" title="class or interface in org.apache.logging.log4j.spi" class="external-link">isClassLoaderDependent</a></code>&nbsp;in interface&nbsp;<code><a href="https://logging.apache.org/log4j/2.x/apidocs/org/apache/logging/log4j/spi/LoggerContextFactory.html" title="class or interface in org.apache.logging.log4j.spi" class="external-link">LoggerContextFactory</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="addShutdownCallback(java.lang.Runnable)">
<h3>addShutdownCallback</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="../util/Cancellable.html" title="interface in org.apache.logging.log4j.core.util">Cancellable</a></span>&nbsp;<span class="element-name">addShutdownCallback</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a>&nbsp;callback)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from interface:&nbsp;<code><a href="../util/ShutdownCallbackRegistry.html#addShutdownCallback(java.lang.Runnable)">ShutdownCallbackRegistry</a></code></span></div>
<div class="block">Adds a Runnable shutdown callback to this class.
Note: The returned <code>Cancellable</code> must be retained on heap by caller
to avoid premature garbage-collection of the registered callback (and to ensure
the callback runs on shutdown).</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="../util/ShutdownCallbackRegistry.html#addShutdownCallback(java.lang.Runnable)">addShutdownCallback</a></code>&nbsp;in interface&nbsp;<code><a href="../util/ShutdownCallbackRegistry.html" title="interface in org.apache.logging.log4j.core.util">ShutdownCallbackRegistry</a></code></dd>
<dt>Parameters:</dt>
<dd><code>callback</code> - the shutdown callback to be executed upon shutdown.</dd>
<dt>Returns:</dt>
<dd>a Cancellable wrapper of the provided callback or <code>null</code> if the shutdown hook is disabled and
cannot be added.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="isShutdownHookEnabled()">
<h3>isShutdownHookEnabled</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">isShutdownHookEnabled</span>()</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>