| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_144) on Tue Feb 25 21:03:10 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>JndiContextSelector (Apache Log4j Core 2.13.1 API)</title> |
| <meta name="date" content="2020-02-25"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JndiContextSelector (Apache Log4j Core 2.13.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JndiContextSelector.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/selector/CoreContextSelectors.html" title="class in org.apache.logging.log4j.core.selector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html" title="interface in org.apache.logging.log4j.core.selector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/selector/JndiContextSelector.html" target="_top">Frames</a></li> |
| <li><a href="JndiContextSelector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.core.selector</div> |
| <h2 title="Class JndiContextSelector" class="title">Class JndiContextSelector</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.core.selector.JndiContextSelector</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a>, <a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">NamedContextSelector</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.87">JndiContextSelector</a> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">NamedContextSelector</a></pre> |
| <div class="block">This class can be used to define a custom logger repository. It makes use of the fact that in J2EE environments, each |
| web-application is guaranteed to have its own JNDI context relative to the <code>java:comp/env</code> context. In |
| EJBs, each enterprise bean (albeit not each application) has its own context relative to the |
| <code>java:comp/env</code> context. An <code>env-entry</code> in a deployment descriptor provides the information to |
| the JNDI context. Once the <code>env-entry</code> is set, a repository selector can query the JNDI application |
| context to look up the value of the entry. The logging context of the web-application will depend on the value the |
| env-entry. The JNDI context which is looked up by this class is <code>java:comp/env/log4j/context-name</code>. |
| |
| <p> |
| Here is an example of an <code>env-entry</code>: |
| </p> |
| <blockquote> |
| |
| <pre> |
| <env-entry> |
| <description>JNDI logging context name for this app</description> |
| <env-entry-name>log4j/context-name</env-entry-name> |
| <env-entry-value>aDistinctiveLoggingContextName</env-entry-value> |
| <env-entry-type>java.lang.String</env-entry-type> |
| </env-entry> |
| </pre> |
| |
| </blockquote> |
| |
| <p> |
| <em>If multiple applications use the same logging context name, then they |
| will share the same logging context.</em> |
| </p> |
| |
| <p> |
| You can also specify the URL for this context's configuration resource. This repository selector |
| (ContextJNDISelector) will use this resource to automatically configure the log4j repository. |
| </p> |
| <blockquote> |
| |
| <pre> |
| <env-entry> |
| <description>URL for configuring log4j context</description> |
| <env-entry-name>log4j/configuration-resource</env-entry-name> |
| <env-entry-value>urlOfConfigurationResource</env-entry-value> |
| <env-entry-type>java.lang.String</env-entry-type> |
| </env-entry> |
| </pre> |
| |
| </blockquote> |
| |
| <p> |
| It usually good practice for configuration resources of distinct applications to have distinct names. However, if |
| this is not possible Naming |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields.inherited.from.class.org.apache.logging.log4j.core.selector.ContextSelector"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from interface org.apache.logging.log4j.core.selector.<a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></h3> |
| <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#DEFAULT_STOP_TIMEOUT">DEFAULT_STOP_TIMEOUT</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#JndiContextSelector--">JndiContextSelector</a></span>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#getContext-java.lang.String-java.lang.ClassLoader-boolean-">getContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext)</code> |
| <div class="block">Returns the LoggerContext.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#getContext-java.lang.String-java.lang.ClassLoader-boolean-java.net.URI-">getContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> configLocation)</code> |
| <div class="block">Returns the LoggerContext.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#getLoggerContexts--">getLoggerContexts</a></span>()</code> |
| <div class="block">Returns a List of all the available LoggerContexts.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#hasContext-java.lang.String-java.lang.ClassLoader-boolean-">hasContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext)</code> |
| <div class="block">Checks to see if a LoggerContext is installed.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#locateContext-java.lang.String-java.lang.Object-java.net.URI-">locateContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> externalContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> configLocation)</code> |
| <div class="block">Locate the LoggerContext with the specified name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#removeContext-org.apache.logging.log4j.core.LoggerContext-">removeContext</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> context)</code> |
| <div class="block">Remove any references to the LoggerContext.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#removeContext-java.lang.String-">removeContext</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block">Locate the LoggerContext with the specified name using the default configuration.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/selector/JndiContextSelector.html#shutdown-java.lang.String-java.lang.ClassLoader-boolean-boolean-">shutdown</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext, |
| boolean allContexts)</code> |
| <div class="block">Shuts down the LoggerContext.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JndiContextSelector--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JndiContextSelector</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.87">JndiContextSelector</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="shutdown-java.lang.String-java.lang.ClassLoader-boolean-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>shutdown</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.97">shutdown</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext, |
| boolean allContexts)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#shutdown-java.lang.String-java.lang.ClassLoader-boolean-boolean-">ContextSelector</a></code></span></div> |
| <div class="block">Shuts down the LoggerContext.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#shutdown-java.lang.String-java.lang.ClassLoader-boolean-boolean-">shutdown</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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</dd> |
| <dd><code>allContexts</code> - if true all LoggerContexts that can be located will be shutdown.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasContext-java.lang.String-java.lang.ClassLoader-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasContext</h4> |
| <pre>public boolean <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.111">hasContext</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#hasContext-java.lang.String-java.lang.ClassLoader-boolean-">ContextSelector</a></code></span></div> |
| <div class="block">Checks to see if a LoggerContext is installed. The default implementation returns false.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#hasContext-java.lang.String-java.lang.ClassLoader-boolean-">hasContext</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></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><span class="returnLabel">Returns:</span></dt> |
| <dd>true if a LoggerContext has been installed, false otherwise.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContext-java.lang.String-java.lang.ClassLoader-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.124">getContext</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#getContext-java.lang.String-java.lang.ClassLoader-boolean-">ContextSelector</a></code></span></div> |
| <div class="block">Returns the LoggerContext.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#getContext-java.lang.String-java.lang.ClassLoader-boolean-">getContext</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fqcn</code> - The fully qualified class name of the caller.</dd> |
| <dd><code>loader</code> - 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><span class="returnLabel">Returns:</span></dt> |
| <dd>The LoggerContext.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getContext-java.lang.String-java.lang.ClassLoader-boolean-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getContext</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.129">getContext</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> fqcn, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/ClassLoader.html?is-external=true" title="class or interface in java.lang">ClassLoader</a> loader, |
| boolean currentContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> configLocation)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#getContext-java.lang.String-java.lang.ClassLoader-boolean-java.net.URI-">ContextSelector</a></code></span></div> |
| <div class="block">Returns the LoggerContext.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#getContext-java.lang.String-java.lang.ClassLoader-boolean-java.net.URI-">getContext</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>fqcn</code> - The fully qualified class name of the caller.</dd> |
| <dd><code>loader</code> - 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>configLocation</code> - The location of the configuration for the LoggerContext.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The LoggerContext.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="locateContext-java.lang.String-java.lang.Object-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>locateContext</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.160">locateContext</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> externalContext, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</a> configLocation)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html#locateContext-java.lang.String-java.lang.Object-java.net.URI-">NamedContextSelector</a></code></span></div> |
| <div class="block">Locate the LoggerContext with the specified name.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html#locateContext-java.lang.String-java.lang.Object-java.net.URI-">locateContext</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">NamedContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The LoggerContext name.</dd> |
| <dd><code>externalContext</code> - The external context to associate with the LoggerContext.</dd> |
| <dd><code>configLocation</code> - The location of the configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LoggerContext.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeContext-org.apache.logging.log4j.core.LoggerContext-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeContext</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.173">removeContext</a>(<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> context)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#removeContext-org.apache.logging.log4j.core.LoggerContext-">ContextSelector</a></code></span></div> |
| <div class="block">Remove any references to the LoggerContext.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#removeContext-org.apache.logging.log4j.core.LoggerContext-">removeContext</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>context</code> - The context to remove.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="removeContext-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>removeContext</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.183">removeContext</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html#removeContext-java.lang.String-">NamedContextSelector</a></code></span></div> |
| <div class="block">Locate the LoggerContext with the specified name using the default configuration.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html#removeContext-java.lang.String-">removeContext</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">NamedContextSelector</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - The LoggerContext name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A LoggerContext.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLoggerContexts--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getLoggerContexts</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../../org/apache/logging/log4j/core/LoggerContext.html" title="class in org.apache.logging.log4j.core">LoggerContext</a>> <a href="../../../../../../src-html/org/apache/logging/log4j/core/selector/JndiContextSelector.html#line.188">getLoggerContexts</a>()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#getLoggerContexts--">ContextSelector</a></code></span></div> |
| <div class="block">Returns a List of all the available LoggerContexts.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html#getLoggerContexts--">getLoggerContexts</a></code> in interface <code><a href="../../../../../../org/apache/logging/log4j/core/selector/ContextSelector.html" title="interface in org.apache.logging.log4j.core.selector">ContextSelector</a></code></dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The List of LoggerContexts.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/JndiContextSelector.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/selector/CoreContextSelectors.html" title="class in org.apache.logging.log4j.core.selector"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/selector/NamedContextSelector.html" title="interface in org.apache.logging.log4j.core.selector"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/selector/JndiContextSelector.html" target="_top">Frames</a></li> |
| <li><a href="JndiContextSelector.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2020 <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> |
| </body> |
| </html> |