| <!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 Sun May 10 12:47:45 MST 2020 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>ConfigurationSource (Apache Log4j Core 2.13.3 API)</title> |
| <meta name="date" content="2020-05-10"> |
| <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="ConfigurationSource (Apache Log4j Core 2.13.3 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/ConfigurationSource.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/config/ConfigurationScheduler.CronRunnable.html" title="class in org.apache.logging.log4j.core.config"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/config/Configurator.html" title="class in org.apache.logging.log4j.core.config"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/config/ConfigurationSource.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurationSource.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.config</div> |
| <h2 title="Class ConfigurationSource" class="title">Class ConfigurationSource</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.config.ConfigurationSource</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.44">ConfigurationSource</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></pre> |
| <div class="block">Represents the source for the logging configuration.</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> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#COMPOSITE_SOURCE">COMPOSITE_SOURCE</a></span></code> |
| <div class="block">ConfigurationSource to use with <a href="../../../../../../org/apache/logging/log4j/core/config/composite/CompositeConfiguration.html" title="class in org.apache.logging.log4j.core.config.composite"><code>CompositeConfiguration</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#NULL_SOURCE">NULL_SOURCE</a></span></code> |
| <div class="block">ConfigurationSource to use with Configurations that do not require a "real" configuration source.</div> |
| </td> |
| </tr> |
| </table> |
| </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/config/ConfigurationSource.html#ConfigurationSource-java.io.InputStream-">ConfigurationSource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream)</code> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#ConfigurationSource-java.io.InputStream-java.io.File-">ConfigurationSource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</code> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream that originated from the specified |
| file.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#ConfigurationSource-java.io.InputStream-java.net.URL-">ConfigurationSource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)</code> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream that originated from the specified |
| url.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#ConfigurationSource-java.io.InputStream-java.net.URL-long-">ConfigurationSource</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url, |
| long lastModified)</code> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream that originated from the specified |
| url.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#ConfigurationSource-org.apache.logging.log4j.core.util.Source-byte:A-long-">ConfigurationSource</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/util/Source.html" title="class in org.apache.logging.log4j.core.util">Source</a> source, |
| byte[] data, |
| long lastModified)</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#fromResource-java.lang.String-java.lang.ClassLoader-">fromResource</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> resource, |
| <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)</code> |
| <div class="block">Retrieves the configuration via the ClassLoader.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#fromUri-java.net.URI-">fromUri</a></span>(<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">Loads the configuration from a URI.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#getFile--">getFile</a></span>()</code> |
| <div class="block">Returns the file configuration source, or <code>null</code> if this configuration source is based on an URL or has |
| neither a file nor an URL.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#getInputStream--">getInputStream</a></span>()</code> |
| <div class="block">Returns the input stream that this configuration source was constructed with.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#getLastModified--">getLastModified</a></span>()</code> |
| <div class="block">Returns the time the resource was last modified or 0 if it is not available.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#getLocation--">getLocation</a></span>()</code> |
| <div class="block">Returns a string describing the configuration source file or URL, or <code>null</code> if this configuration source |
| has neither a file nor an URL.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#getURI--">getURI</a></span>()</code> |
| <div class="block">Returns a URI representing the configuration resource or null if it cannot be determined.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#getURL--">getURL</a></span>()</code> |
| <div class="block">Returns the configuration source URL, or <code>null</code> if this configuration source is based on a file or has |
| neither a file nor an URL.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#resetInputStream--">resetInputStream</a></span>()</code> |
| <div class="block">Returns a new <code>ConfigurationSource</code> whose input stream is reset to the beginning.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#setData-byte:A-">setData</a></span>(byte[] data)</code> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#setModifiedMillis-long-">setModifiedMillis</a></span>(long modifiedMillis)</code> </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#setSource-org.apache.logging.log4j.core.util.Source-">setSource</a></span>(<a href="../../../../../../org/apache/logging/log4j/core/util/Source.html" title="class in org.apache.logging.log4j.core.util">Source</a> source)</code> </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><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></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html#toString--">toString</a></span>()</code> </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#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"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="NULL_SOURCE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>NULL_SOURCE</h4> |
| <pre>public static final <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.52">NULL_SOURCE</a></pre> |
| <div class="block">ConfigurationSource to use with Configurations that do not require a "real" configuration source.</div> |
| </li> |
| </ul> |
| <a name="COMPOSITE_SOURCE"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>COMPOSITE_SOURCE</h4> |
| <pre>public static final <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.57">COMPOSITE_SOURCE</a></pre> |
| <div class="block">ConfigurationSource to use with <a href="../../../../../../org/apache/logging/log4j/core/config/composite/CompositeConfiguration.html" title="class in org.apache.logging.log4j.core.config.composite"><code>CompositeConfiguration</code></a>.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ConfigurationSource-java.io.InputStream-java.io.File-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ConfigurationSource</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.76">ConfigurationSource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> file)</pre> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream that originated from the specified |
| file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the input stream</dd> |
| <dd><code>file</code> - the file where the input stream originated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ConfigurationSource-java.io.InputStream-java.net.URL-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ConfigurationSource</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.98">ConfigurationSource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url)</pre> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream that originated from the specified |
| url.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the input stream</dd> |
| <dd><code>url</code> - the URL where the input stream originated</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ConfigurationSource-java.io.InputStream-java.net.URL-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ConfigurationSource</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.115">ConfigurationSource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream, |
| <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> url, |
| long lastModified)</pre> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream that originated from the specified |
| url.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the input stream</dd> |
| <dd><code>url</code> - the URL where the input stream originated</dd> |
| <dd><code>lastModified</code> - when the source was last modified.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ConfigurationSource-java.io.InputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ConfigurationSource</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.131">ConfigurationSource</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> stream) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Constructs a new <code>ConfigurationSource</code> with the specified input stream. Since the stream is the only source |
| of data, this constructor makes a copy of the stream contents.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stream</code> - the input stream</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an exception occurred reading from the specified stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="ConfigurationSource-org.apache.logging.log4j.core.util.Source-byte:A-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ConfigurationSource</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.135">ConfigurationSource</a>(<a href="../../../../../../org/apache/logging/log4j/core/util/Source.html" title="class in org.apache.logging.log4j.core.util">Source</a> source, |
| byte[] data, |
| long lastModified) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getFile--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFile</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.183">getFile</a>()</pre> |
| <div class="block">Returns the file configuration source, or <code>null</code> if this configuration source is based on an URL or has |
| neither a file nor an URL.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration source file, or <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getURL--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getURL</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.193">getURL</a>()</pre> |
| <div class="block">Returns the configuration source URL, or <code>null</code> if this configuration source is based on a file or has |
| neither a file nor an URL.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the configuration source URL, or <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSource-org.apache.logging.log4j.core.util.Source-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSource</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.197">setSource</a>(<a href="../../../../../../org/apache/logging/log4j/core/util/Source.html" title="class in org.apache.logging.log4j.core.util">Source</a> source)</pre> |
| </li> |
| </ul> |
| <a name="setData-byte:A-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setData</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.201">setData</a>(byte[] data)</pre> |
| </li> |
| </ul> |
| <a name="setModifiedMillis-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setModifiedMillis</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.205">setModifiedMillis</a>(long modifiedMillis)</pre> |
| </li> |
| </ul> |
| <a name="getURI--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getURI</h4> |
| <pre>public <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> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.213">getURI</a>()</pre> |
| <div class="block">Returns a URI representing the configuration resource or null if it cannot be determined.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The URI.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLastModified--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLastModified</h4> |
| <pre>public long <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.244">getLastModified</a>()</pre> |
| <div class="block">Returns the time the resource was last modified or 0 if it is not available.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the last modified time of the resource.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getLocation--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLocation</h4> |
| <pre>public <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> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.254">getLocation</a>()</pre> |
| <div class="block">Returns a string describing the configuration source file or URL, or <code>null</code> if this configuration source |
| has neither a file nor an URL.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a string describing the configuration source file or URL, or <code>null</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInputStream--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInputStream</h4> |
| <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true" title="class or interface in java.io">InputStream</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.263">getInputStream</a>()</pre> |
| <div class="block">Returns the input stream that this configuration source was constructed with.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the input stream that this configuration source was constructed with.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="resetInputStream--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetInputStream</h4> |
| <pre>public <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.273">resetInputStream</a>() |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Returns a new <code>ConfigurationSource</code> whose input stream is reset to the beginning.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a new <code>ConfigurationSource</code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if a problem occurred while opening the new input stream</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <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> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.290">toString</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code><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></code> in class <code><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></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromUri-java.net.URI-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>fromUri</h4> |
| <pre>public static <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.306">fromUri</a>(<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">Loads the configuration from a URI.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>configLocation</code> - A URI representing the location of the configuration.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The ConfigurationSource for the configuration.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="fromResource-java.lang.String-java.lang.ClassLoader-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>fromResource</h4> |
| <pre>public static <a href="../../../../../../org/apache/logging/log4j/core/config/ConfigurationSource.html" title="class in org.apache.logging.log4j.core.config">ConfigurationSource</a> <a href="../../../../../../src-html/org/apache/logging/log4j/core/config/ConfigurationSource.html#line.347">fromResource</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> resource, |
| <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)</pre> |
| <div class="block">Retrieves the configuration via the ClassLoader.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>resource</code> - The resource to load.</dd> |
| <dd><code>loader</code> - The default ClassLoader to use.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The ConfigurationSource for the configuration.</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/ConfigurationSource.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/config/ConfigurationScheduler.CronRunnable.html" title="class in org.apache.logging.log4j.core.config"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../../org/apache/logging/log4j/core/config/Configurator.html" title="class in org.apache.logging.log4j.core.config"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/logging/log4j/core/config/ConfigurationSource.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurationSource.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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> |
