Skip to content

Commit 9f7ecf4

Browse files
Release 2.25 (#219)
* Control versions of indirect dependencies from hadoop (which is needed for parquet at least for now). * Include specific version of protobuf-java for indirect dependencies. * Documentation and dependency updates related to the 2.25 release. * A few more changes to documentation and some changes related to dependency updates (mostly changing test strings to match, but also fixing a deprecated lucene method). * Add some new files/directories to the exclude list for the build. * Update docs with links to where the new war file will be. * Switch back to unpack (instead of unpackWhenChanged) for maven-download-plugin.
1 parent 3f5be46 commit 9f7ecf4

16 files changed

+95
-121
lines changed

DEPLOY_INSTALL.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ ERDDAP™ can run on any server that supports Java and Tomcat (and other applica
2727

2828
ERDDAP™ works with Java from other sources, but we recommend Adoptium because it is the main, community-supported, free (as in beer and speech) version of Java 21 that offers Long Term Support (free upgrades for many years past the initial release). For security reasons, please update your ERDDAP's version of Java periodically as new versions of Java 21 become available from Adoptium.
2929

30-
ERDDAP™ has been tested and used extensively with Java 17 and 21, not other versions. For various reasons, we don't test with nor support other versions of Java.
30+
ERDDAP™ has been tested and used extensively with 21, not other versions. For various reasons, we don't test with nor support other versions of Java.
3131

3232

3333
2. [Set up](#tomcat) [Tomcat](https://tomcat.apache.org).
@@ -37,7 +37,7 @@ ERDDAP™ can run on any server that supports Java and Tomcat (and other applica
3737

3838

3939
* Download Tomcat and unpack it on your server or PC.
40-
For security reasons, it is almost always best to use the latest version of Tomcat 10 (version 9 and below are not acceptable) which is designed to work with Java 17 or newer. Below, the Tomcat directory will be referred to as _tomcat_.
40+
For security reasons, it is almost always best to use the latest version of Tomcat 10 (version 9 and below are not acceptable) which is designed to work with Java 21 or newer. Below, the Tomcat directory will be referred to as _tomcat_.
4141

4242
Warning! If you already have a Tomcat running some other web application (especially THREDDS), we recommend that you install ERDDAP™ in [a second Tomcat](#secondTomcat), because ERDDAP™ needs different Tomcat settings and shouldn't have to contend with other applications for memory.
4343

@@ -173,15 +173,16 @@ ERDDAP™ can run on any server that supports Java and Tomcat (and other applica
173173
* Or, you can join the [ERDDAP™ Google Group / Mailing List](#ERDDAPMailingList) and post your question there.
174174

175175
3. [Set up the _tomcat_/content/erddap configuration files.](#erddapContent)
176-
On Linux, Mac, and Windows, download [erddapContent.zip](https://github.com/ERDDAP/erddap/releases/download/v2.23/erddapContent.zip) (version 2.23, 19810 bytes, MD5=1E26F62E7A06191EE6868C40B9A29362, dated 2023-02-27) and unzip it into _tomcat_, creating _tomcat_/content/erddap .
176+
On Linux, Mac, and Windows, download [erddapContent.zip](https://github.com/ERDDAP/erddapContent/releases/download/content1.0.0/erddapContent.zip) (version 1.0.0, 20333 bytes, MD5=2B8D2A5AE5ED73E3A42B529C168C60B5, dated 2024-10-14) and unzip it into _tomcat_, creating _tomcat_/content/erddap .
177177

178178
[Other Directory:](#erddapContentDirectory) For Red Hat Enterprise Linux (RHEL) or for other situations where you aren't allowed to modify the Tomcat directory or where you want/need to put the ERDDAP™ content directory in some other location for some other reason (for example, if you use Jetty instead of Tomcat), unzip erddapContent.zip into the desired directory (to which only user=tomcat has access) and set the erddapContentDirectory system property (e.g., erddapContentDirectory=~tomcat/content/erddap) so ERDDAP™ can find this new content directory.
179179

180180
\[Some previous versions are also available:
181181
[2.17](https://github.com/ERDDAP/erddap/releases/download/v2.17/erddapContent.zip) (19,792 bytes, MD5=8F892616BAEEF2DF0F4BB036DCB4AD7C, dated 2022-02-16)
182182
[2.18](https://github.com/ERDDAP/erddap/releases/download/v2.18/erddapContent.zip) (19,792 bytes, MD5=8F892616BAEEF2DF0F4BB036DCB4AD7C, dated 2022-02-16)
183183
[2.21](https://github.com/ERDDAP/erddap/releases/download/v2.21/erddapContent.zip) (19,810 bytes, MD5=1E26F62E7A06191EE6868C40B9A29362, dated 2022-10-09)
184-
[2.22](https://github.com/ERDDAP/erddap/releases/download/v2.22/erddapContent.zip) (19,810 bytes, MD5=1E26F62E7A06191EE6868C40B9A29362, dated 2022-12-08)
184+
[2.22](https://github.com/ERDDAP/erddap/releases/download/v2.22/erddapContent.zip) (19,810 bytes, MD5=1E26F62E7A06191EE6868C40B9A29362, dated 2022-12-08)
185+
[2.23](https://github.com/ERDDAP/erddap/releases/download/v2.23/erddapContent.zip) (19,810 bytes, MD5=1E26F62E7A06191EE6868C40B9A29362, dated 2023-02-27)
185186
and unzip it into _tomcat_, creating _tomcat_/content/erddap . \]
186187

187188
Then,
@@ -210,16 +211,19 @@ ERDDAP™ can run on any server that supports Java and Tomcat (and other applica
210211
ERDDAP™ will not work correctly if the setup.xml or datasets.xml file isn't a well-formed XML file. So, after you edit these files, it is a good idea to verify that the result is well-formed XML by pasting the XML text into an XML checker like [xmlvalidation(https://www.xmlvalidation.com/).
211212

212213
4. [Install the erddap.war file.](#erddap.war)
213-
On Linux, Mac, and Windows, download [erddap.war](https://github.com/ERDDAP/erddap/releases/download/v2.24/erddap.war) into _tomcat_/webapps .
214-
(version 2.24, 568,748,187 bytes, MD5=970fbee172e28b0b8a07756eecbc898e, dated 2024-06-07)
214+
On Linux, Mac, and Windows, download [erddap.war](https://github.com/ERDDAP/erddap/releases/download/v2.25/erddap.war) into _tomcat_/webapps .
215+
(version 2.25, 592,429,675 bytes, MD5=0D93F045A3F38018117C0BB5BA419C99, dated 2024-10-17)
216+
215217
The .war file is big because it contains high resolution coastline, boundary, and elevation data needed to create maps.
216218

217219
\[Some previous versions are also available.
218220
[2.17](https://github.com/ERDDAP/erddap/releases/download/v2.17/erddap.war) (551,068,245 bytes, MD5=5FEA912B5D42E50EAB9591F773EA848D, dated 2022-02-16)
219221
[2.18](https://github.com/ERDDAP/erddap/releases/download/v2.18/erddap.war) (551,069,844 bytes, MD5=461325E97E7577EC671DD50246CCFB8B, dated 2022-02-23)
220222
[2.21](https://github.com/ERDDAP/erddap/releases/download/v2.21/erddap.war) (568,644,411 bytes, MD5=F2CFF805893146E932E498FDDBD519B6, dated 2022-10-09)
221223
[2.22](https://github.com/ERDDAP/erddap/releases/download/v2.22/erddap.war) (567,742,765 bytes, MD5=2B33354F633294213AE2AFDDCF4DA6D0, dated 2022-12-08)
222-
[2.23](https://github.com/ERDDAP/erddap/releases/download/v2.23/erddap.war)(version 2.23, 572,124,953 bytes, MD5=D843A043C506725EBD6F8EFDCCA8FD5F, dated 2023-03-03) \]
224+
[2.23](https://github.com/ERDDAP/erddap/releases/download/v2.23/erddap.war) (572,124,953 bytes, MD5=D843A043C506725EBD6F8EFDCCA8FD5F, dated 2023-03-03)
225+
[2.24](https://github.com/ERDDAP/erddap/releases/download/v2.24/erddap.war) (568,748,187 bytes, MD5=970fbee172e28b0b8a07756eecbc898e, dated 2024-06-07)
226+
\]
223227

224228
5. [Use ProxyPass](#ProxyPass) so users don't have to put the port number, e.g., :8080, in the URL.
225229
On Linux computers, if Tomcat is running in Apache, please modify the Apache httpd.conf file (usually in /etc/httpd/conf/ ) to allow HTTP traffic to/from ERDDAP™ without requiring the port number, e.g., :8080, in the URL. As the root user:

DEPLOY_UPDATE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
1. Make the changes listed in [Changes](https://erddap.github.io/changes.html) in the section entitled "Things ERDDAP™ Administrators Need to Know and Do" for all of the ERDDAP™ versions since the version you were using.
55

6-
2. If you are upgrading from ERDDAP™ version 2.18 or below, you need to switch to Java 17 (or newer) and the related Tomcat 10. See the regular ERDDAP™ installation instructions for [Java](#java) and [Tomcat](#tomcat). You'll also have to copy your _tomcat_/content/erddap directory from your old Tomcat installation to your new Tomcat installation.
6+
2. If you are upgrading from ERDDAP™ version 2.18 or below, you need to switch to Java 21 (or newer) and the related Tomcat 10. See the regular ERDDAP™ installation instructions for [Java](#java) and [Tomcat](#tomcat). You'll also have to copy your _tomcat_/content/erddap directory from your old Tomcat installation to your new Tomcat installation.
77

8-
3. Download [erddap.war](https://github.com/ERDDAP/erddap/releases/download/v2.24/erddap.war) into _tomcat_/webapps .
9-
(version 2.24, 568,748,187 bytes, MD5=970fbee172e28b0b8a07756eecbc898e, dated 2024-06-07)
8+
3. Download [erddap.war](https://github.com/ERDDAP/erddap/releases/download/v2.25/erddap.war) into _tomcat_/webapps .
9+
(version 2.25, 592,429,675 bytes, MD5=0D93F045A3F38018117C0BB5BA419C99, dated 2024-10-17)
1010

1111
4. [messages.xml](#messages.xml)
1212
* Common: If you are upgrading from ERDDAP™ version 1.46 (or above) and you just use the standard messages, the new standard messages.xml will be installed automatically (amongst the .class files via erddap.war).

PROGRAMMER_GUIDE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ERDDAP™ uses Maven to load code dependencies as well as some static reference
1717

1818
- [ref\_files.zip](https://github.com/ERDDAP/ERDDAPRefFiles/releases/download/1.0.0/ref_files.zip) and unzip it into /WEB-INF/ref/ .
1919

20-
- [erddapContent.zip](https://github.com/ERDDAP/erddap/releases/download/v2.24/erddapContent.zip) (version 2.24, 19810 bytes, MD5=1E26F62E7A06191EE6868C40B9A29362, dated 2024-06-07) and unzip it into _tomcat_, creating _tomcat_/content/erddap .
20+
- [erddapContent.zip](https://github.com/ERDDAP/erddapContent/releases/download/content1.0.0/erddapContent.zip) (version 1.0.0, 20333 bytes, MD5=2B8D2A5AE5ED73E3A42B529C168C60B5, dated 2024-10-14) and unzip it into _tomcat_, creating _tomcat_/content/erddap .
2121

2222
NOTE: Maven caches downloads but will unzip the downloaded archives on each execution, which takes time. To skip downloading
2323
and unzipping archives, you may specify the `skipResourceDownload` property to Maven (e.g. `mvn -DskipResourceDownload package`).

WEB-INF/classes/gov/noaa/pfel/erddap/Erddap.java

+3-1
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@
7070
import java.util.regex.Pattern;
7171
import java.util.zip.ZipOutputStream;
7272
import org.apache.lucene.document.Document;
73+
import org.apache.lucene.index.StoredFields;
7374
import org.apache.lucene.index.Term;
7475
import org.apache.lucene.search.BooleanClause;
7576
import org.apache.lucene.search.BooleanQuery;
@@ -16118,6 +16119,7 @@ public StringArray getSearchDatasetIDs(
1611816119
+ (System.currentTimeMillis() - luceneTime)
1611916120
+ "ms");
1612016121
luceneTime = System.currentTimeMillis();
16122+
StoredFields storedFields = indexSearcher.storedFields();
1612116123
for (int i = 0; i < nHits; i++) {
1612216124
// 3 ways to find datasetID:
1612316125

@@ -16134,7 +16136,7 @@ public StringArray getSearchDatasetIDs(
1613416136
Integer docNI = Integer.valueOf(docN);
1613516137
String tDatasetID = EDStatic.luceneDocNToDatasetID.get(docNI);
1613616138
if (tDatasetID == null) { // not yet in luceneDocNToDatasetID
16137-
Document doc = indexSearcher.doc(docN);
16139+
Document doc = storedFields.document(docN);
1613816140
if (doc == null) // perhaps just removed from index
1613916141
continue;
1614016142
tDatasetID = doc.get("datasetID");

WEB-INF/classes/gov/noaa/pfel/erddap/util/EDStatic.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,8 @@ public class EDStatic {
195195
* 2.21 released on 2022-10-09 <br>
196196
* 2.22 released on 2022-12-08 <br>
197197
* 2.23 released on 2023-02-27 <br>
198-
* 2.24 released on 2024-06-07
198+
* 2.24 released on 2024-06-07 <br>
199+
* 2.25 released on 2024-10-16 <br>
199200
*
200201
* <p>For main branch releases, this will be a floating point number with 2 decimal digits, with
201202
* no additional text. !!! In general, people other than the main ERDDAP developer (Bob) should
@@ -205,7 +206,7 @@ public class EDStatic {
205206
* anything following it. A request to http.../erddap/version will return just the number (as
206207
* text). A request to http.../erddap/version_string will return the full string.
207208
*/
208-
public static String erddapVersion = "2.24"; // see comment above
209+
public static String erddapVersion = "2.25"; // see comment above
209210

210211
/**
211212
* This is almost always false. During development, Bob sets this to true. No one else needs to.
@@ -1806,7 +1807,7 @@ public static int convertToPublicSourceUrlFromSlashPo(String tFrom) {
18061807
private static Table gdxAcronymsTable;
18071808

18081809
private static HashMap<String, String> gdxAcronymsHashMap, gdxVariableNamesHashMap;
1809-
public static boolean useSharedWatchService = false;
1810+
public static boolean useSharedWatchService = true;
18101811

18111812
/**
18121813
* This static block reads this class's static String values from contentDirectory, which must
@@ -2276,7 +2277,7 @@ public static int convertToPublicSourceUrlFromSlashPo(String tFrom) {
22762277
variablesMustHaveIoosCategory =
22772278
getSetupEVBoolean(setup, ev, "variablesMustHaveIoosCategory", true);
22782279
warName = getSetupEVString(setup, ev, "warName", "erddap");
2279-
useSharedWatchService = getSetupEVBoolean(setup, ev, "useSharedWatchService", false);
2280+
useSharedWatchService = getSetupEVBoolean(setup, ev, "useSharedWatchService", true);
22802281

22812282
// use Lucence?
22822283
if (searchEngine.equals("lucene")) {

download/AccessToPrivateDatasets.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
194194

195195
<br>&nbsp;
196196
<hr>
197-
<p>ERDDAP, Version 2.21
197+
<p>ERDDAP, Version 2.25
198198
<br><a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
199199
<a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
200200
<p>&nbsp;

download/EDDTableFromEML.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
606606

607607
<br>&nbsp;
608608
<hr>
609-
<p>ERDDAP, Version 2.24
609+
<p>ERDDAP, Version 2.25
610610
<br><a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
611611
<a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
612612

download/NCCSV.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -943,7 +943,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
943943

944944
<br>&nbsp;
945945
<hr>
946-
<p>ERDDAP, Version 2.24
946+
<p>ERDDAP, Version 2.25
947947
<br><a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
948948
<a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
949949
</div>

download/NCCSV_1.00.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -859,7 +859,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
859859

860860
<br>&nbsp;
861861
<hr>
862-
<p>ERDDAP, Version 2.24
862+
<p>ERDDAP, Version 2.25
863863
<br><a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
864864
<a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
865865
</div>

download/NCCSV_1.10.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -930,7 +930,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
930930

931931
<br>&nbsp;
932932
<hr>
933-
<p>ERDDAP, Version 2.24
933+
<p>ERDDAP, Version 2.25
934934
<br><a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
935935
<a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
936936
</div>

download/changes.html

+25-5
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,6 @@ <h1 style="text-align:center;">ERDDAP™ Changes</h1>
7070

7171
<!-- ****************************************************************************** -->
7272

73-
<!-- TODO Make sure github.io site is updated with all the latest documentation for release -->
7473
<h2><a class="selfLink" id="changes2.25" href="#changes2.25" rel="bookmark">Changes</a>
7574
in ERDDAP™ version 2.25 (released TBD)</h2>
7675
<ul>
@@ -81,6 +80,15 @@ <h2><a class="selfLink" id="changes2.25" href="#changes2.25" rel="bookmark">Chan
8180
</ul>
8281
<li><strong>Things ERDDAP™ Administrators Need to Know and Do:</strong>
8382
<ul>
83+
<li>We recommend upgradding to Java 21 or newer. This is the LTS version and has been available for over a year. Development
84+
of ERDDAP™ version 2.25 was done with Java 21.
85+
<br>&nbsp;
86+
<li>The SharedWatchService is now the default. If you need to disable it, please contact chris.john at noaa.gov to let me know,
87+
so I can improve it in future versions and add:
88+
<br><kbd>
89+
&lt;useSharedWatchService&gt;false&lt;/useSharedWatchService&gt;
90+
</kbd> to your setup.xml.
91+
<br>&nbsp;
8492
<li>The ERDDAP™ servlet will now start at server startup. Which means datasets will begin loading immediately instead of
8593
waiting until a request is made.
8694
<br>&nbsp;
@@ -149,9 +157,9 @@ <h2><a class="selfLink" id="changes2.24" href="#changes2.24" rel="bookmark">Chan
149157
threads used to watch for changes. It does mean all datasets get updated together instead of each dataset
150158
having its own update frequency. Most likely this will mean more frequent updates for most datasets.
151159

152-
<br>To enable this add <kbd>
153-
<useSharedWatchService>true</useSharedWatchService>
154-
</kbd> to your setup.xml.
160+
<br><p>To enable this add <kbd>
161+
&lt;useSharedWatchService&gt;true&lt;/useSharedWatchService&gt;
162+
</kbd> to your setup.xml.</p>
155163

156164
<br>Please do try this and report back how it works for you to chris.john at noaa.gov.
157165
<br>&nbsp;
@@ -161,6 +169,18 @@ <h2><a class="selfLink" id="changes2.24" href="#changes2.24" rel="bookmark">Chan
161169
<li>Some small changes and bug fixes.
162170
<br>&nbsp;
163171
</ul>
172+
<li><strong>Improvements for ERDDAP™ developers:</strong>
173+
<ul>
174+
<li>Support for local development using Docker.
175+
Thanks Matt Hopson and Roje.
176+
<br>&nbsp;
177+
<li>Support for local development using Jetty and documentation improvements.
178+
Thanks Micah Wengren.
179+
<br>&nbsp;
180+
<li>Changes to tests to reduce issues cross platform.
181+
Thanks Shane St. Savage.
182+
<br>&nbsp;
183+
</ul>
164184
</ul>
165185

166186
<!-- ****************************************************************************** -->
@@ -7137,7 +7157,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
71377157

71387158
<br>&nbsp;
71397159
<hr>
7140-
<p>ERDDAP, Version 2.24
7160+
<p>ERDDAP, Version 2.25
71417161
<br><a href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
71427162
<a href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
71437163

download/grids.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1248,7 +1248,7 @@ <h3><a class="selfLink" id="RemoteReplicationOfDatasets_Solutions" href="#Remote
12481248

12491249
<br>&nbsp;
12501250
<hr>
1251-
<p>ERDDAP, Version 2.24
1251+
<p>ERDDAP, Version 2.25
12521252
<br><a rel="help" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
12531253
<a rel="help" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
12541254

download/setup.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -4302,7 +4302,7 @@ <h2><a class="selfLink" id="contact" href="#contact" rel="bookmark">Contact</a><
43024302

43034303
<br>&nbsp;
43044304
<hr>
4305-
<p>ERDDAP, Version 2.24
4305+
<p>ERDDAP, Version 2.25
43064306
<br><a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html">Disclaimers</a> |
43074307
<a rel="bookmark" href="https://coastwatch.pfeg.noaa.gov/erddap/legal.html#privacyPolicy">Privacy Policy</a>
43084308

0 commit comments

Comments
 (0)