Apache Solr open-source search software
SOLR-17675: Remove DirContext param from DirectoryFactory create method. (#3194)
Bruno Roustant5ac5c26c92c9
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex 083b2981167..b54b271e560 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -148,6 +148,8 @@ Other Changes* 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)+================== 9.9.0 ==================New Features---------------------diff --git a/solr/core/src/java/org/apache/solr/core/ByteBuffersDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/ByteBuffersDirectoryFactory.javaindex 0c1a1fa24f0..aeed5d589f4 100644--- a/solr/core/src/java/org/apache/solr/core/ByteBuffersDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/ByteBuffersDirectoryFactory.java@@ -41,8 +41,7 @@ public class ByteBuffersDirectoryFactory extends EphemeralDirectoryFactory {}@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {return new ByteBuffersDirectory(lockFactory);}}diff --git a/solr/core/src/java/org/apache/solr/core/CachingDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/CachingDirectoryFactory.javaindex 14cbbaff3db..99047fc6690 100644--- a/solr/core/src/java/org/apache/solr/core/CachingDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/CachingDirectoryFactory.java@@ -47,7 +47,7 @@ import org.slf4j.LoggerFactory;/*** A {@link DirectoryFactory} impl base class for caching Directory instances per path. Most* DirectoryFactory implementations will want to extend this class and simply implement {@link- * DirectoryFactory#create(String, LockFactory, DirContext)}.+ * DirectoryFactory#create(String, LockFactory)}.** <p>This is an expert class and these API's are subject to change.*/@@ -402,7 +402,7 @@ public abstract class CachingDirectoryFactory extends DirectoryFactory {cacheValue = byPathCache.get(fullPath);if (cacheValue == null) {- directory = create(fullPath, createLockFactory(rawLockType), dirContext);+ directory = create(fullPath, createLockFactory(rawLockType));assert ObjectReleaseTracker.track(directory);boolean success = false;try {diff --git a/solr/core/src/java/org/apache/solr/core/DirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/DirectoryFactory.javaindex 348a5767c38..843c33ca692 100644--- a/solr/core/src/java/org/apache/solr/core/DirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/DirectoryFactory.java@@ -90,7 +90,7 @@ public abstract class DirectoryFactory implements NamedListInitializedPlugin, Clpublic abstract void addCloseListener(Directory dir, CloseListener closeListener);/**- * Close this factory and all of the Directories it contains.+ * Close this factory and all the Directories it contains.** @throws IOException If there is a low-level I/O error.*/@@ -102,10 +102,7 @@ public abstract class DirectoryFactory implements NamedListInitializedPlugin, Cl** @throws IOException If there is a low-level I/O error.*/- // TODO: remove the DirContext param from this method and have the DirectoryFactory implementation- // extend the new CachingDirectoryFactory.filterDirectory if needed.- protected abstract Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException;+ protected abstract Directory create(String path, LockFactory lockFactory) throws IOException;/*** Creates a new LockFactory for a given path.diff --git a/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.javaindex 30735cc696d..b96cd1f14a8 100644--- a/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/MMapDirectoryFactory.java@@ -63,8 +63,7 @@ public class MMapDirectoryFactory extends StandardDirectoryFactory {}@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {MMapDirectory mapDirectory = new MMapDirectory(Path.of(path), lockFactory, maxChunk);mapDirectory.setPreload(preload);return mapDirectory;diff --git a/solr/core/src/java/org/apache/solr/core/NIOFSDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/NIOFSDirectoryFactory.javaindex f8895ecab67..5cc591afb71 100644--- a/solr/core/src/java/org/apache/solr/core/NIOFSDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/NIOFSDirectoryFactory.java@@ -26,8 +26,7 @@ import org.apache.lucene.store.NIOFSDirectory;public class NIOFSDirectoryFactory extends StandardDirectoryFactory {@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {return new NIOFSDirectory(Path.of(path), lockFactory);}}diff --git a/solr/core/src/java/org/apache/solr/core/NRTCachingDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/NRTCachingDirectoryFactory.javaindex a0a58ac62a4..5e2a63a8a5f 100644--- a/solr/core/src/java/org/apache/solr/core/NRTCachingDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/NRTCachingDirectoryFactory.java@@ -47,8 +47,7 @@ public class NRTCachingDirectoryFactory extends StandardDirectoryFactory {}@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {return new NRTCachingDirectory(FSDirectory.open(Path.of(path), lockFactory), maxMergeSizeMB, maxCachedMB);}diff --git a/solr/core/src/java/org/apache/solr/core/RAMDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/RAMDirectoryFactory.javaindex cfe321a62cb..052dc0106f1 100644--- a/solr/core/src/java/org/apache/solr/core/RAMDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/RAMDirectoryFactory.java@@ -41,8 +41,7 @@ public class RAMDirectoryFactory extends EphemeralDirectoryFactory {}@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {return new ByteBuffersDirectory(lockFactory);}}diff --git a/solr/core/src/java/org/apache/solr/core/StandardDirectoryFactory.java b/solr/core/src/java/org/apache/solr/core/StandardDirectoryFactory.javaindex 5d02de67aa9..56900021b13 100644--- a/solr/core/src/java/org/apache/solr/core/StandardDirectoryFactory.java+++ b/solr/core/src/java/org/apache/solr/core/StandardDirectoryFactory.java@@ -48,8 +48,7 @@ public class StandardDirectoryFactory extends CachingDirectoryFactory {private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {return FSDirectory.open(Path.of(path), lockFactory);}diff --git a/solr/core/src/test/org/apache/solr/core/AlternateDirectoryTest.java b/solr/core/src/test/org/apache/solr/core/AlternateDirectoryTest.javaindex 4daaf5cdc10..53603a1f931 100644--- a/solr/core/src/test/org/apache/solr/core/AlternateDirectoryTest.java+++ b/solr/core/src/test/org/apache/solr/core/AlternateDirectoryTest.java@@ -51,7 +51,7 @@ public class AlternateDirectoryTest extends SolrTestCaseJ4 {public static volatile boolean openCalled = false;@Override- public Directory create(String path, LockFactory lockFactory, DirContext dirContext) {+ public Directory create(String path, LockFactory lockFactory) {openCalled = true;return newFSDirectory(Path.of(path), lockFactory);diff --git a/solr/core/src/test/org/apache/solr/core/ByteBuffersDirectoryFactoryTest.java b/solr/core/src/test/org/apache/solr/core/ByteBuffersDirectoryFactoryTest.javaindex 2858acf723a..ba3c04ab6df 100644--- a/solr/core/src/test/org/apache/solr/core/ByteBuffersDirectoryFactoryTest.java+++ b/solr/core/src/test/org/apache/solr/core/ByteBuffersDirectoryFactoryTest.java@@ -31,7 +31,7 @@ public class ByteBuffersDirectoryFactoryTest extends SolrTestCaseJ4 {ByteBuffersDirectoryFactory factory =new ByteBuffersDirectoryFactory() {@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext) {+ protected Directory create(String path, LockFactory lockFactory) {return directory;}};diff --git a/solr/core/src/test/org/apache/solr/core/RAMDirectoryFactoryTest.java b/solr/core/src/test/org/apache/solr/core/RAMDirectoryFactoryTest.javaindex 6547cf48659..c0c418f8f82 100644--- a/solr/core/src/test/org/apache/solr/core/RAMDirectoryFactoryTest.java+++ b/solr/core/src/test/org/apache/solr/core/RAMDirectoryFactoryTest.java@@ -36,7 +36,7 @@ public class RAMDirectoryFactoryTest extends SolrTestCase {RAMDirectoryFactory factory =new RAMDirectoryFactory() {@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext) {+ protected Directory create(String path, LockFactory lockFactory) {return directory;}};diff --git a/solr/core/src/test/org/apache/solr/handler/admin/CoreMergeIndexesAdminHandlerTest.java b/solr/core/src/test/org/apache/solr/handler/admin/CoreMergeIndexesAdminHandlerTest.javaindex 7de13638991..cbe7e7f46e6 100644--- a/solr/core/src/test/org/apache/solr/handler/admin/CoreMergeIndexesAdminHandlerTest.java+++ b/solr/core/src/test/org/apache/solr/handler/admin/CoreMergeIndexesAdminHandlerTest.java@@ -52,12 +52,11 @@ public class CoreMergeIndexesAdminHandlerTest extends SolrTestCaseJ4 {public boolean fail = false;@Override- public Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ public Directory create(String path, LockFactory lockFactory) throws IOException {if (fail) {throw new FailingDirectoryFactoryException();} else {- return super.create(path, lockFactory, dirContext);+ return super.create(path, lockFactory);}}}diff --git a/solr/test-framework/src/java/org/apache/solr/core/MockDirectoryFactory.java b/solr/test-framework/src/java/org/apache/solr/core/MockDirectoryFactory.javaindex 101c465bc4e..7e20d4b4241 100644--- a/solr/test-framework/src/java/org/apache/solr/core/MockDirectoryFactory.java+++ b/solr/test-framework/src/java/org/apache/solr/core/MockDirectoryFactory.java@@ -44,8 +44,7 @@ public class MockDirectoryFactory extends EphemeralDirectoryFactory {}@Override- protected Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ protected Directory create(String path, LockFactory lockFactory) throws IOException {Directory dir;if (useMockDirectoryWrapper) dir = LuceneTestCase.newMockDirectory();else dir = LuceneTestCase.newDirectory(); // we ignore the given lock factorydiff --git a/solr/test-framework/src/java/org/apache/solr/core/MockFSDirectoryFactory.java b/solr/test-framework/src/java/org/apache/solr/core/MockFSDirectoryFactory.javaindex b8e1684becf..b130a0bc877 100644--- a/solr/test-framework/src/java/org/apache/solr/core/MockFSDirectoryFactory.java+++ b/solr/test-framework/src/java/org/apache/solr/core/MockFSDirectoryFactory.java@@ -30,8 +30,7 @@ import org.apache.lucene.tests.util.LuceneTestCase;public class MockFSDirectoryFactory extends StandardDirectoryFactory {@Override- public Directory create(String path, LockFactory lockFactory, DirContext dirContext)- throws IOException {+ public Directory create(String path, LockFactory lockFactory) throws IOException {Directory dir = LuceneTestCase.newFSDirectory(Path.of(path), lockFactory);// we can't currently do this check because of how// Solr has to reboot a new Directory sometimes when replicating