org.apache.sis.console/org/apache/sis/console/ResourcesDownloader.html - sis-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (21) on Thu Oct 05 19:54:57 CEST 2023 -->
 <title>ResourcesDownloader (Apache SIS 1.4 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="dc.created" content="2023-10-05">
 <meta name="description" content="declaration: module: org.apache.sis.console, package: org.apache.sis.console, class: ResourcesDownloader">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <meta name="keywords" content="org.apache.sis.console.ResourcesDownloader class">
 <meta name="keywords" content="getLocale()">
 <meta name="keywords" content="getAuthorities()">
 <meta name="keywords" content="askUserAgreement()">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../sis.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style">
 <script type="text/javascript" src="../../../../../script.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script>
 <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../../index.html">Overview</a></li>
 <li><a href="../../../../module-summary.html">Module</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../../index-all.html">Index</a></li>
 <li><a href="../../../../../help-doc.html#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <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>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li>Field</li>
 <li><a href="#constructor-detail">Constr</a></li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><a href="../../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="module-label-in-type">Module</span>&nbsp;<a href="../../../../module-summary.html">org.apache.sis.console</a></div>
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.sis.console</a></div>
 <h1 title="Class ResourcesDownloader" class="title">Class ResourcesDownloader</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>
 <div class="inheritance"><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/InstallationResources.html" title="class in org.apache.sis.setup">InstallationResources</a>
 <div class="inheritance"><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a>
 <div class="inheritance">ResourcesDownloader</div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">ResourcesDownloader</span>
 <span class="extends-implements">extends <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a></span></div>
 <div class="block">A provider for data licensed under different terms of use than the Apache license.
  This class is in charge of downloading the data if necessary and asking user's agreement
  before to install them. Authorities managed by the current implementation are:

  <ul>
    <li><code>"EPSG"</code> for the EPSG geodetic dataset.</li>
  </ul></div>
 <dl class="notes">
 <dt>Since:</dt>
 <dd>0.7</dd>
 </dl>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-OptionalInstallations">Fields inherited from class&nbsp;<a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a></h3>
 <code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#destinationDirectory">destinationDirectory</a></code></div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ResourcesDownloader</a>()</code></div>
 <div class="col-last even-row-color">
 <div class="block">Creates a new installation scripts provider.</div>
 </div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#askUserAgreement(java.lang.String,java.lang.String)" class="member-name-link">askUserAgreement</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;authority,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;license)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Asks to the user if (s)he agree to download and install the resource for the given authority.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><wbr>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAuthorities()" class="member-name-link">getAuthorities</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the name of the authority who provides data under non-Apache terms of use.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLocale()" class="member-name-link">getLocale</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Returns the locale to use for messages shown to the user.</div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-OptionalInstallations">Methods inherited from class&nbsp;<a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a></h3>
 <code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getLicense(java.lang.String,java.util.Locale,java.lang.String)">getLicense</a>, <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getResource(java.lang.String,int)">getResource</a>, <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getResourceNames(java.lang.String)">getResourceNames</a>, <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getSpaceRequirement(java.lang.String)">getSpaceRequirement</a>, <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#openScript(java.lang.String,int)">openScript</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-InstallationResources">Methods inherited from class&nbsp;<a href="../../../../../org.apache.sis.util/org/apache/sis/setup/InstallationResources.html" title="class in org.apache.sis.setup">InstallationResources</a></h3>
 <code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/InstallationResources.html#getInstructionURL()">getInstructionURL</a>, <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/InstallationResources.html#load()">load</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-Object">Methods inherited from class&nbsp;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>ResourcesDownloader</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">ResourcesDownloader</span>()</div>
 <div class="block">Creates a new installation scripts provider.</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="getLocale()">
 <h3>getLocale</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Locale.html" title="class or interface in java.util" class="external-link">Locale</a></span>&nbsp;<span class="element-name">getLocale</span>()</div>
 <div class="block">Returns the locale to use for messages shown to the user.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html#getLocale()">getLocale</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org.apache.sis.util/org/apache/sis/util/Localized.html" title="interface in org.apache.sis.util">Localized</a></code></dd>
 <dt>Overrides:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getLocale()">getLocale</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a></code></dd>
 <dt>Returns:</dt>
 <dd>the locale of messages shown to the user.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getAuthorities()">
 <h3>getAuthorities</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a>&lt;<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;</span>&nbsp;<span class="element-name">getAuthorities</span>()</div>
 <div class="block">Returns the name of the authority who provides data under non-Apache terms of use.
  If this <code>ResourcesDownloader</code> cannot ask user's agreement because there is
  no <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/Console.html" title="class or interface in java.io" class="external-link"><code>Console</code></a> attached to the current Java virtual machine, then this method
  returns an empty set.</div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getAuthorities()">getAuthorities</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a></code></dd>
 <dt>Returns:</dt>
 <dd><code>"EPSG"</code> or an empty set.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="askUserAgreement(java.lang.String,java.lang.String)">
 <h3>askUserAgreement</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name">askUserAgreement</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;authority,
  <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;license)</span></div>
 <div class="block">Asks to the user if (s)he agree to download and install the resource for the given authority.
  This method may be invoked twice for the same <code>authority</code> argument:
  first with a null <code>license</code> argument for asking if the user agrees to download the data,
  then with a non-null <code>license</code> argument for asking if the user agrees with the license terms.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#askUserAgreement(java.lang.String,java.lang.String)">askUserAgreement</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html" title="class in org.apache.sis.setup">OptionalInstallations</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>authority</code> - one of the authorities returned by <a href="../../../../../org.apache.sis.util/org/apache/sis/setup/OptionalInstallations.html#getAuthorities()"><code>OptionalInstallations.getAuthorities()</code></a>.</dd>
 <dd><code>license</code> - the license, or <code>null</code> for asking if the user wants to download the data.</dd>
 <dt>Returns:</dt>
 <dd>whether user accepted.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 </div>
 </div>
 </body>
 </html>