SOLR-16903: Make java.io.File a forbidden API

gradle/validation/forbidden-apis/defaults.all.txt

@@ -99,4 +99,7 @@ java.util.Locale#<init>(**)
 java.nio.file.Paths#get(**)
 
 @defaultMessage You probably meant to call String.startsWith
-java.nio.file.Path#startsWith(java.lang.String)
+java.nio.file.Path#startsWith(java.lang.String)
+
+@defaultMessage Use NIO Path instead of File
+java.io.File

solr/CHANGES.txt

@@ -152,12 +152,10 @@ Other Changes
 
 * SOLR-17321: Minimum Java version for Apache Solr is now 21, and for SolrJ, it is 17. (Sanjay Dutt, David Smiley)
 
-* SOLR-16903: Update CLI tools and Solr Core to use java.nio.file.Path instead of java.io.File (Andrey Bozhko, Matthew Biscocho)
+* SOLR-16903: Replace all java.io.File usages to java.nio.file.Path (NIO) (Andrey Bozhko, Matthew Biscocho)
 
 * SOLR-17568: SolrCloud no longer reroutes/proxies a core request to another node if not found locally. (David Smiley)
 
-* SOLR-17548: Switch all public Java APIs from File to Path. (Matthew Biscocho via Eric Pugh)
-
 * SOLR-17675: Remove DirContext param from DirectoryFactory.create method. (Bruno Roustant, David Smiley)
 
 * SOLR-16903: Switch CoreContainer#getSolrHome to return Path instead of String (Andrey Bozhko)

solr/core/src/java/org/apache/solr/core/CoreContainer.java

@@ -34,6 +34,7 @@
 import jakarta.inject.Singleton;
 import java.io.IOException;
 import java.lang.invoke.MethodHandles;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.text.SimpleDateFormat;
 import java.util.Arrays;
@@ -988,28 +989,67 @@ private void loadInternal() {
     Path dataHome =
         cfg.getSolrDataHome() != null ? cfg.getSolrDataHome() : cfg.getCoreRootDirectory();
     solrMetricsContext.gauge(
-        () -> dataHome.toFile().getTotalSpace(),
+        () -> {
+          try {
+            return Files.getFileStore(dataHome).getTotalSpace();
+          } catch (IOException e) {
+            throw new SolrException(
+                ErrorCode.SERVER_ERROR,
+                "Error retrieving total space for data home directory" + dataHome,
+                e);
+          }
+        },
         true,
         "totalSpace",
         SolrInfoBean.Category.CONTAINER.toString(),
         "fs");
+
     solrMetricsContext.gauge(
-        () -> dataHome.toFile().getUsableSpace(),
+        () -> {
+          try {
+            return Files.getFileStore(dataHome).getUsableSpace();
+          } catch (IOException e) {
+            throw new SolrException(
+                ErrorCode.SERVER_ERROR,
+                "Error retrieving usable space for data home directory" + dataHome,
+                e);
+          }
+        },
         true,
         "usableSpace",
         SolrInfoBean.Category.CONTAINER.toString(),
         "fs");
     solrMetricsContext.gauge(
         dataHome::toString, true, "path", SolrInfoBean.Category.CONTAINER.toString(), "fs");
     solrMetricsContext.gauge(
-        () -> cfg.getCoreRootDirectory().toFile().getTotalSpace(),
+        () -> {
+          try {
+            return Files.getFileStore(cfg.getCoreRootDirectory()).getTotalSpace();
+          } catch (IOException e) {
+            throw new SolrException(
+                SolrException.ErrorCode.SERVER_ERROR,
+                "Error retrieving total space for core root directory: "
+                    + cfg.getCoreRootDirectory(),
+                e);
+          }
+        },
         true,
         "totalSpace",
         SolrInfoBean.Category.CONTAINER.toString(),
         "fs",
         "coreRoot");
     solrMetricsContext.gauge(
-        () -> cfg.getCoreRootDirectory().toFile().getUsableSpace(),
+        () -> {
+          try {
+            return Files.getFileStore(cfg.getCoreRootDirectory()).getUsableSpace();
+          } catch (IOException e) {
+            throw new SolrException(
+                SolrException.ErrorCode.SERVER_ERROR,
+                "Error retrieving usable space for core root directory: "
+                    + cfg.getCoreRootDirectory(),
+                e);
+          }
+        },
         true,
         "usableSpace",
         SolrInfoBean.Category.CONTAINER.toString(),

solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java

@@ -285,7 +285,12 @@ public MetaData getMetaData() {
 
         @Override
         public Date getTimeStamp() {
-          return new Date(realPath().toFile().lastModified());
+          try {
+            return new Date(Files.getLastModifiedTime(realPath()).toMillis());
+          } catch (IOException e) {
+            throw new SolrException(
+                SERVER_ERROR, "Failed to retrieve the last modified time for: " + realPath(), e);
+          }
         }
 
         @Override
@@ -295,7 +300,12 @@ public boolean isDir() {
 
         @Override
         public long size() {
-          return realPath().toFile().length();
+          try {
+            return Files.size(realPath());
+          } catch (IOException e) {
+            throw new SolrException(
+                SERVER_ERROR, "Failed to retrieve the file size for: " + realPath(), e);
+          }
         }
 
         @Override

solr/core/src/java/org/apache/solr/packagemanager/DefaultPackageRepository.java

@@ -31,6 +31,7 @@
 import java.util.stream.Collectors;
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.io.FilenameUtils;
+import org.apache.commons.io.file.PathUtils;
 import org.apache.solr.common.SolrException;
 import org.apache.solr.common.SolrException.ErrorCode;
 import org.slf4j.Logger;
@@ -80,7 +81,7 @@ public boolean hasPackage(String packageName) {
   @Override
   public Path download(String artifactName) throws SolrException, IOException {
     Path tmpDirectory = Files.createTempDirectory("solr-packages");
-    tmpDirectory.toFile().deleteOnExit();
+    PathUtils.deleteOnExit(tmpDirectory);
     URL url = getRepoUri().resolve(artifactName).toURL();
     String fileName = FilenameUtils.getName(url.getPath());
     Path destination = tmpDirectory.resolve(fileName);

solr/core/src/java/org/apache/solr/update/UpdateLog.java

@@ -55,6 +55,7 @@
 import java.util.concurrent.atomic.AtomicInteger;
 import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Stream;
+import org.apache.commons.io.file.PathUtils;
 import org.apache.lucene.store.Directory;
 import org.apache.lucene.util.BytesRef;
 import org.apache.solr.common.SolrDocumentBase;
@@ -2439,7 +2440,7 @@ public static void deleteFile(Path file) {
 
     if (!success) {
       try {
-        file.toFile().deleteOnExit();
+        PathUtils.deleteOnExit(file);
       } catch (Exception e) {
         log.error("Error deleting file on exit: {}", file, e);
       }

solr/core/src/test/org/apache/solr/cli/SolrCLIZkToolsTest.java

@@ -146,7 +146,8 @@ public void testDownconfig() throws Exception {
     verifyZkLocalPathsMatch(tmp.resolve("conf"), "/configs/downconfig2");
     // And insure the empty file is a text file
     Path destEmpty = tmp2.resolve("conf").resolve("stopwords").resolve("emptyfile");
-    assertTrue("Empty files should NOT be copied down as directories", destEmpty.toFile().isFile());
+    assertTrue(
+        "Empty files should NOT be copied down as directories", Files.isRegularFile(destEmpty));
   }
 
   @Test
@@ -326,7 +327,7 @@ public void testCp() throws Exception {
 
     // Next, copy cp7 down and verify that zknode.data exists for cp7
     Path zData = tmp.resolve("conf/stopwords/zknode.data");
-    assertTrue("znode.data should have been copied down", zData.toFile().exists());
+    assertTrue("znode.data should have been copied down", Files.exists(zData));
 
     // Finally, copy up to cp8 and verify that the data is up there.
     args = new String[] {"cp", "--recursive", "--zk-host", zkAddr, "file:" + tmp, "zk:/cp9"};
@@ -385,7 +386,8 @@ public void testCp() throws Exception {
     assertEquals("Copy should have succeeded.", 0, res);
 
     Path locEmpty = tmp2.resolve("stopwords/emptyfile");
-    assertTrue("Empty files should NOT be copied down as directories", locEmpty.toFile().isFile());
+    assertTrue(
+        "Empty files should NOT be copied down as directories", Files.isRegularFile(locEmpty));
   }
 
   @Test

solr/core/src/test/org/apache/solr/cli/SolrProcessManagerTest.java

@@ -54,8 +54,7 @@ public static void beforeClass() throws Exception {
     long processHttpsValue = isWindows ? processHttps.getKey() : processHttps.getValue().pid();
     SolrProcessManager.enableTestingMode = true;
     System.setProperty("jetty.port", Integer.toString(processHttp.getKey()));
-    Path pidDir = Files.createTempDirectory("solr-pid-dir").toAbsolutePath();
-    pidDir.toFile().deleteOnExit();
+    Path pidDir = createTempDir("solr-pid-dir");
     System.setProperty("solr.pid.dir", pidDir.toString());
     Files.writeString(
         pidDir.resolve("solr-" + processHttpValue + PID_SUFFIX), Long.toString(processHttpValue));

solr/core/src/test/org/apache/solr/cloud/ShardRoutingCustomTest.java

@@ -61,8 +61,7 @@ private void doCustomSharding() throws Exception {
     Files.createDirectories(jettyDir);
     setupJettySolrHome(jettyDir);
     JettySolrRunner j =
-        createJetty(
-            jettyDir, createTempDir().toFile().getAbsolutePath(), "shardA", "solrconfig.xml", null);
+        createJetty(jettyDir, createTempDir().toString(), "shardA", "solrconfig.xml", null);
     j.start();
     assertEquals(
         0,

solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPI.java

@@ -205,7 +205,6 @@ private void setupBaseConfigSet(String baseConfigSetName, Map<String, String> ol
       throws Exception {
     final Path configDir = getFile("solr").resolve("configsets/configset-2/conf");
     final Path tmpConfigDir = createTempDir();
-    tmpConfigDir.toFile().deleteOnExit();
     PathUtils.copyDirectory(configDir, tmpConfigDir);
     if (oldProps != null) {
       Files.writeString(
@@ -1565,7 +1564,6 @@ public void testDeleteErrors() throws Exception {
     final SolrClient solrClient = getHttpSolrClient(baseUrl);
     final Path configDir = getFile("solr").resolve("configsets/configset-2/conf");
     final Path tmpConfigDir = createTempDir();
-    tmpConfigDir.toFile().deleteOnExit();
     // Ensure ConfigSet is immutable
     PathUtils.copyDirectory(configDir, tmpConfigDir);
     Files.writeString(

solr/core/src/test/org/apache/solr/cloud/TestConfigSetsAPIZkFailure.java

@@ -143,7 +143,6 @@ private void setupBaseConfigSet(String baseConfigSetName, Map<String, String> ol
       throws Exception {
     final Path configDir = getFile("solr").resolve("configsets/configset-2/conf");
     final Path tmpConfigDir = createTempDir();
-    tmpConfigDir.toFile().deleteOnExit();
     PathUtils.copyDirectory(configDir, tmpConfigDir);
     if (oldProps != null) {
       Files.writeString(

solr/core/src/test/org/apache/solr/core/CachingDirectoryFactoryTest.java

@@ -96,7 +96,7 @@ public void reorderingTest() throws Exception {
       df.release(a);
       assertTrue(
           "The path " + pathA + " should exist because it has subdirs that prevent removal",
-          pathA.toFile().exists()); // we know there are subdirs that should prevent removal
+          Files.exists(pathA)); // we know there are subdirs that should prevent removal
       Collections.shuffle(Arrays.asList(subdirs), r);
       for (Map.Entry<String, Directory> e : subdirs) {
         boolean after = removeAfter.getAsBoolean();
@@ -126,7 +126,7 @@ public void reorderingTest() throws Exception {
       } else {
         assertTrue(
             "There are subdirs to wait on, so the parent directory should still exist",
-            pathA.toFile().exists()); // parent must still be present
+            Files.exists(pathA)); // parent must still be present
         for (Map.Entry<String, Directory> e : subdirs) {
           Path path = Path.of(e.getKey());
           boolean exists = Files.exists(path);

solr/core/src/test/org/apache/solr/core/snapshots/TestSolrCloudSnapshots.java

@@ -183,7 +183,7 @@ public void testSnapshots() throws Exception {
       BackupRestoreUtils.verifyDocs(0, solrClient, collectionName);
     }
 
-    String backupLocation = createTempDir().toFile().getAbsolutePath();
+    String backupLocation = createTempDir().toString();
     String backupName = "mytestbackup";
     String restoreCollectionName = collectionName + "_restored";
 

solr/core/src/test/org/apache/solr/core/snapshots/TestSolrCoreSnapshots.java

@@ -92,7 +92,7 @@ public void testBackupRestore() throws Exception {
         CollectionAdminRequest.createCollection(collectionName, "conf1", 1, 1);
     create.process(solrClient);
 
-    String location = createTempDir().toFile().getAbsolutePath();
+    String location = createTempDir().toString();
     int nDocs = BackupRestoreUtils.indexDocs(cluster.getSolrClient(), collectionName, docsSeed);
 
     DocCollection collectionState = solrClient.getClusterState().getCollection(collectionName);

solr/core/src/test/org/apache/solr/handler/TestRestoreCore.java

@@ -117,7 +117,7 @@ public void testSimpleRestore() throws Exception {
 
     // Use the default backup location or an externally provided location.
     if (random().nextBoolean()) {
-      location = createTempDir().toFile().getAbsolutePath();
+      location = createTempDir().toString();
       leaderJetty
           .getCoreContainer()
           .getAllowPaths()
@@ -182,8 +182,7 @@ public void testSimpleRestore() throws Exception {
 
   public void testBackupFailsMissingAllowPaths() throws Exception {
     final String params =
-        "&location="
-            + URLEncoder.encode(createTempDir().toFile().getAbsolutePath(), StandardCharsets.UTF_8);
+        "&location=" + URLEncoder.encode(createTempDir().toString(), StandardCharsets.UTF_8);
     Throwable t =
         expectThrows(
             IOException.class,
@@ -199,7 +198,7 @@ public void testBackupFailsMissingAllowPaths() throws Exception {
   public void testFailedRestore() throws Exception {
     int nDocs = BackupRestoreUtils.indexDocs(leaderClient, "collection1", docsSeed);
 
-    String location = createTempDir().toFile().getAbsolutePath();
+    String location = createTempDir().toString();
     leaderJetty.getCoreContainer().getAllowPaths().add(Path.of(location));
     String snapshotName = TestUtil.randomSimpleString(random(), 1, 5);
     String params =

solr/core/src/test/org/apache/solr/handler/V2ApiIntegrationTest.java

@@ -236,7 +236,7 @@ public void testCollectionsApi() throws Exception {
     assertEquals(
         "/collections/collection1/get",
         Utils.getObjectByPath(result, true, "/spec[0]/url/paths[0]"));
-    String tempDir = createTempDir().toFile().getPath();
+    String tempDir = createTempDir().toString();
     Map<String, Object> backupParams = new HashMap<>();
     backupParams.put("location", tempDir);
     cluster

solr/modules/jwt-auth/src/test/org/apache/solr/security/jwt/JWTAuthPluginIntegrationTest.java

@@ -55,6 +55,7 @@
 import org.apache.http.entity.ByteArrayEntity;
 import org.apache.http.entity.ContentType;
 import org.apache.http.impl.client.CloseableHttpClient;
+import org.apache.lucene.tests.mockfile.FilterPath;
 import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.client.solrj.impl.HttpClientUtil;
 import org.apache.solr.cloud.MiniSolrCloudCluster;
@@ -104,9 +105,7 @@ public static void beforeClass() throws Exception {
     pemFilePath = JWT_TEST_PATH().resolve("security").resolve("jwt_plugin_idp_cert.pem");
     wrongPemFilePath = JWT_TEST_PATH().resolve("security").resolve("jwt_plugin_idp_wrongcert.pem");
 
-    Path tempDir = Files.createTempDirectory(JWTAuthPluginIntegrationTest.class.getSimpleName());
-    tempDir.toFile().deleteOnExit();
-
+    Path tempDir = FilterPath.unwrap(createTempDir());
     Path modifiedP12Cert = tempDir.resolve(p12Cert.getFileName());
     new KeystoreGenerator()
         .generateKeystore(

solr/modules/llm/src/test/org/apache/solr/llm/TestLlmBase.java

@@ -60,9 +60,7 @@ protected static void setupTest(
   protected static void initFolders(boolean isPersistent) throws Exception {
     tmpSolrHome = createTempDir();
     tmpConfDir = tmpSolrHome.resolve(CONF_DIR);
-    tmpConfDir.toFile().deleteOnExit();
     PathUtils.copyDirectory(TEST_PATH(), tmpSolrHome.toAbsolutePath());
-
     final Path modelStore = tmpConfDir.resolve(MODEL_FILE_NAME);
 
     if (isPersistent) {

solr/modules/ltr/src/test/org/apache/solr/ltr/TestRerankBase.java

@@ -136,7 +136,6 @@ protected static void setupTestInit(String solrconfig, String schema, boolean is
       throws Exception {
     tmpSolrHome = createTempDir();
     tmpConfDir = tmpSolrHome.resolve(CONF_DIR);
-    tmpConfDir.toFile().deleteOnExit();
     PathUtils.copyDirectory(TEST_PATH(), tmpSolrHome);
 
     final Path fstore = tmpConfDir.resolve(FEATURE_FILE_NAME);