| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.13) on Tue Feb 08 12:40:05 CST 2022 --> |
| <title>BaseHome (Eclipse Jetty API Doc - v10.0.8)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-02-08"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BaseHome (Eclipse Jetty API Doc - v10.0.8)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"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"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseHome.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" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.start</a></div> |
| <h2 title="Class BaseHome" class="title">Class BaseHome</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.start.BaseHome</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>public class <span class="typeNameLabel">BaseHome</span> |
| extends java.lang.Object</pre> |
| <div class="block">File access for <code>${jetty.home}</code>, <code>${jetty.base}</code>, directories. |
| <p> |
| By default, both <code>${jetty.home}</code> and <code>${jetty.base}</code> are the same directory, but they can point at different directories. |
| <p> |
| The <code>${jetty.home}</code> directory is where the main Jetty binaries and default configuration is housed. |
| <p> |
| The <code>${jetty.base}</code> directory is where the execution specific configuration and webapps are obtained from.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="BaseHome.SearchDir.html" title="class in org.eclipse.jetty.start">BaseHome.SearchDir</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Field</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_BASE">JETTY_BASE</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#JETTY_HOME">JETTY_HOME</a></span></code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">BaseHome</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(java.lang.String%5B%5D)">BaseHome</a></span>​(java.lang.String[] cmdLine)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.start.config.CommandLineConfigSource)">BaseHome</a></span>​(<a href="config/CommandLineConfigSource.html" title="class in org.eclipse.jetty.start.config">CommandLineConfigSource</a> cmdLineSource)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.start.config.ConfigSources)">BaseHome</a></span>​(<a href="config/ConfigSources.html" title="class in org.eclipse.jetty.start.config">ConfigSources</a> sources)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <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="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBase()">getBase</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>java.nio.file.Path</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBasePath()">getBasePath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.nio.file.Path</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBasePath(java.lang.String)">getBasePath</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Create a <code>Path</code> reference to some content in <code>"${jetty.base}"</code></div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="config/ConfigSources.html" title="class in org.eclipse.jetty.start.config">ConfigSources</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfigSources()">getConfigSources</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHome()">getHome</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>java.nio.file.Path</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getHomePath()">getHomePath</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.nio.file.Path</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPath(java.lang.String)">getPath</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a specific path reference.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>java.util.List<java.nio.file.Path></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPaths(java.lang.String)">getPaths</a></span>​(java.lang.String pattern)</code></th> |
| <td class="colLast"> |
| <div class="block">Get a List of <code>Path</code>s from a provided pattern.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>java.util.List<java.nio.file.Path></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPaths(java.nio.file.Path,int,java.lang.String)">getPaths</a></span>​(java.nio.file.Path dir, |
| int searchDepth, |
| java.lang.String pattern)</code></th> |
| <td class="colLast"> |
| <div class="block">Search specified Path with pattern and return hits</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBaseDifferent()">isBaseDifferent</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toShortForm(java.io.File)">toShortForm</a></span>​(java.io.File path)</code></th> |
| <td class="colLast"> |
| <div class="block">Convenience method for <code>toShortForm(file.toPath())</code></div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toShortForm(java.lang.String)">toShortForm</a></span>​(java.lang.String path)</code></th> |
| <td class="colLast"> |
| <div class="block">Replace/Shorten arbitrary path with property strings <code>"${jetty.home}"</code> or <code>"${jetty.base}"</code> where appropriate.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#toShortForm(java.nio.file.Path)">toShortForm</a></span>​(java.nio.file.Path path)</code></th> |
| <td class="colLast"> |
| <div class="block">Replace/Shorten arbitrary path with property strings <code>"${jetty.home}"</code> or <code>"${jetty.base}"</code> where appropriate.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a id="JETTY_BASE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>JETTY_BASE</h4> |
| <pre>public static final java.lang.String JETTY_BASE</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.jetty.start.BaseHome.JETTY_BASE">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="JETTY_HOME"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JETTY_HOME</h4> |
| <pre>public static final java.lang.String JETTY_HOME</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.eclipse.jetty.start.BaseHome.JETTY_HOME">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BaseHome</h4> |
| <pre>public BaseHome() |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BaseHome</h4> |
| <pre>public BaseHome​(java.lang.String[] cmdLine) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.start.config.CommandLineConfigSource)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>BaseHome</h4> |
| <pre>public BaseHome​(<a href="config/CommandLineConfigSource.html" title="class in org.eclipse.jetty.start.config">CommandLineConfigSource</a> cmdLineSource) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="<init>(org.eclipse.jetty.start.config.ConfigSources)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>BaseHome</h4> |
| <pre>public BaseHome​(<a href="config/ConfigSources.html" title="class in org.eclipse.jetty.start.config">ConfigSources</a> sources)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getBase()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBase</h4> |
| <pre class="methodSignature">public java.lang.String getBase()</pre> |
| </li> |
| </ul> |
| <a id="getBasePath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBasePath</h4> |
| <pre class="methodSignature">public java.nio.file.Path getBasePath()</pre> |
| </li> |
| </ul> |
| <a id="getBasePath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBasePath</h4> |
| <pre class="methodSignature">public java.nio.file.Path getBasePath​(java.lang.String path)</pre> |
| <div class="block">Create a <code>Path</code> reference to some content in <code>"${jetty.base}"</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path to reference</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the file reference</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getConfigSources()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConfigSources</h4> |
| <pre class="methodSignature">public <a href="config/ConfigSources.html" title="class in org.eclipse.jetty.start.config">ConfigSources</a> getConfigSources()</pre> |
| </li> |
| </ul> |
| <a id="getHome()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHome</h4> |
| <pre class="methodSignature">public java.lang.String getHome()</pre> |
| </li> |
| </ul> |
| <a id="getHomePath()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getHomePath</h4> |
| <pre class="methodSignature">public java.nio.file.Path getHomePath()</pre> |
| </li> |
| </ul> |
| <a id="getPath(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPath</h4> |
| <pre class="methodSignature">public java.nio.file.Path getPath​(java.lang.String path)</pre> |
| <div class="block">Get a specific path reference. |
| <p> |
| Path references are searched based on the config source search order. |
| <ol> |
| <li>If provided path is an absolute reference., and exists, return that reference</li> |
| <li>If exists relative to <code>${jetty.base}</code>, return that reference</li> |
| <li>If exists relative to and <code>include-jetty-dir</code> locations, return that reference</li> |
| <li>If exists relative to <code>${jetty.home}</code>, return that reference</li> |
| <li>Return standard <code>Path</code> reference obtained from <code>FileSystem.getPath(String, String...)</code> (no exists check performed)</li> |
| </ol></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path to get.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the path reference.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPaths(java.nio.file.Path,int,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPaths</h4> |
| <pre class="methodSignature">public java.util.List<java.nio.file.Path> getPaths​(java.nio.file.Path dir, |
| int searchDepth, |
| java.lang.String pattern) |
| throws java.io.IOException</pre> |
| <div class="block">Search specified Path with pattern and return hits</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dir</code> - the path to a directory to start search from</dd> |
| <dd><code>searchDepth</code> - the number of directories deep to perform the search</dd> |
| <dd><code>pattern</code> - the raw pattern to use for the search (must be relative)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the list of Paths found</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if unable to search the path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="getPaths(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPaths</h4> |
| <pre class="methodSignature">public java.util.List<java.nio.file.Path> getPaths​(java.lang.String pattern) |
| throws java.io.IOException</pre> |
| <div class="block">Get a List of <code>Path</code>s from a provided pattern. |
| <p> |
| Resolution Steps: |
| <ol> |
| <li>If the pattern starts with "regex:" or "glob:" then a standard <code>PathMatcher</code> is built using |
| <code>FileSystem.getPathMatcher(String)</code> as a file search.</li> |
| <li>If pattern starts with a known filesystem root (using information from <code>FileSystem.getRootDirectories()</code>) then this is assumed to |
| be a absolute file system pattern.</li> |
| <li>All other patterns are treated as relative to BaseHome information: |
| <ol> |
| <li>Search ${jetty.home} first</li> |
| <li>Search ${jetty.base} for overrides</li> |
| </ol> |
| </li> |
| </ol> |
| <p> |
| Pattern examples: |
| <dl> |
| <dt><code>lib/logging/*.jar</code></dt> |
| <dd>Relative pattern, not recursive, search <code>${jetty.home}</code> then <code>${jetty.base}</code> for lib/logging/*.jar content</dd> |
| |
| <dt><code>lib/**/*-dev.jar</code></dt> |
| <dd>Relative pattern, recursive search <code>${jetty.home}</code> then <code>${jetty.base}</code> for files under <code>lib</code> ending in |
| <code>-dev.jar</code></dd> |
| |
| <dt><code>etc/jetty.xml</code></dt> |
| <dd>Relative pattern, no glob, search for <code>${jetty.home}/etc/jetty.xml</code> then <code>${jetty.base}/etc/jetty.xml</code></dd> |
| |
| <dt><code>glob:/opt/app/common/*-corp.jar</code></dt> |
| <dd>PathMapper pattern, glob, search <code>/opt/app/common/</code> for <code>*-corp.jar</code></dd> |
| |
| </dl> |
| |
| <p> |
| Notes: |
| <ul> |
| <li>FileSystem case sensitivity is implementation specific (eg: linux is case-sensitive, windows is case-insensitive).<br> |
| See <code>FileSystem.getPathMatcher(String)</code> for more details</li> |
| <li>Pattern slashes are implementation neutral (use '/' always and you'll be fine)</li> |
| <li>Recursive searching is limited to 30 levels deep (not configurable)</li> |
| <li>File System loops are detected and skipped</li> |
| </ul></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>pattern</code> - the pattern to search.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the collection of paths found</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code> - if error during search operation</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isBaseDifferent()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isBaseDifferent</h4> |
| <pre class="methodSignature">public boolean isBaseDifferent()</pre> |
| </li> |
| </ul> |
| <a id="toShortForm(java.io.File)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toShortForm</h4> |
| <pre class="methodSignature">public java.lang.String toShortForm​(java.io.File path)</pre> |
| <div class="block">Convenience method for <code>toShortForm(file.toPath())</code></div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path to shorten</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the short form of the path as a String</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toShortForm(java.nio.file.Path)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toShortForm</h4> |
| <pre class="methodSignature">public java.lang.String toShortForm​(java.nio.file.Path path)</pre> |
| <div class="block">Replace/Shorten arbitrary path with property strings <code>"${jetty.home}"</code> or <code>"${jetty.base}"</code> where appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path to shorten</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the potentially shortened path</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="toShortForm(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toShortForm</h4> |
| <pre class="methodSignature">public java.lang.String toShortForm​(java.lang.String path)</pre> |
| <div class="block">Replace/Shorten arbitrary path with property strings <code>"${jetty.home}"</code> or <code>"${jetty.base}"</code> where appropriate.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>path</code> - the path to shorten</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the potentially shortened path</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/BaseHome.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" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
