You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2023/01/14 16:38:14 UTC

[lucene] branch branch_9x updated: deprecate non-NRT replication support (#12038)

This is an automated email from the ASF dual-hosted git repository.

rmuir pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/lucene.git


The following commit(s) were added to refs/heads/branch_9x by this push:
     new aafe2001fa7 deprecate non-NRT replication support (#12038)
aafe2001fa7 is described below

commit aafe2001fa72069ee0deab3142a017aa8ab1940d
Author: Robert Muir <rm...@apache.org>
AuthorDate: Sat Jan 14 11:37:36 2023 -0500

    deprecate non-NRT replication support (#12038)
---
 lucene/CHANGES.txt                                                  | 3 +++
 .../lucene/replicator/IndexAndTaxonomyReplicationHandler.java       | 2 ++
 .../java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java | 2 ++
 .../java/org/apache/lucene/replicator/IndexInputInputStream.java    | 2 ++
 .../java/org/apache/lucene/replicator/IndexReplicationHandler.java  | 2 ++
 .../src/java/org/apache/lucene/replicator/IndexRevision.java        | 2 ++
 .../src/java/org/apache/lucene/replicator/LocalReplicator.java      | 2 ++
 .../org/apache/lucene/replicator/PerSessionDirectoryFactory.java    | 2 ++
 .../src/java/org/apache/lucene/replicator/ReplicationClient.java    | 2 ++
 .../src/java/org/apache/lucene/replicator/Replicator.java           | 2 ++
 .../replicator/src/java/org/apache/lucene/replicator/Revision.java  | 2 ++
 .../src/java/org/apache/lucene/replicator/RevisionFile.java         | 2 ++
 .../java/org/apache/lucene/replicator/SessionExpiredException.java  | 2 ++
 .../src/java/org/apache/lucene/replicator/SessionToken.java         | 2 ++
 .../src/java/org/apache/lucene/replicator/http/HttpClientBase.java  | 2 ++
 .../src/java/org/apache/lucene/replicator/http/HttpReplicator.java  | 2 ++
 .../java/org/apache/lucene/replicator/http/ReplicationService.java  | 2 ++
 .../src/java/org/apache/lucene/replicator/http/package-info.java    | 6 +++++-
 18 files changed, 40 insertions(+), 1 deletion(-)

diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 1cf0e88b6dc..cb15fb5c2c5 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -59,6 +59,9 @@ API Changes
   can only be disabled globally by passing the following sysprop on Java command line:
   "-Dorg.apache.lucene.store.MMapDirectory.enableUnmapHack=false" (Uwe Schindler)
 
+* GITHUB#12038: Deprecate non-NRT replication support.
+  Please migrate to org.apache.lucene.replicator.nrt instead. (Robert Muir)
+
 New Features
 ---------------------
 * GITHUB#11795: Add ByteWritesTrackingDirectoryWrapper to expose metrics for bytes merged, flushed, and overall
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyReplicationHandler.java b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyReplicationHandler.java
index 27bb1d43a3c..fffb80c98bc 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyReplicationHandler.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyReplicationHandler.java
@@ -41,7 +41,9 @@ import org.apache.lucene.util.InfoStream;
  *
  * @see IndexReplicationHandler
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class IndexAndTaxonomyReplicationHandler implements ReplicationHandler {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java
index 6222e11c9fc..7e7061476b4 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexAndTaxonomyRevision.java
@@ -39,7 +39,9 @@ import org.apache.lucene.store.IOContext;
  *
  * @see IndexRevision
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class IndexAndTaxonomyRevision implements Revision {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexInputInputStream.java b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexInputInputStream.java
index 841e242bb9c..150afbf1501 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexInputInputStream.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexInputInputStream.java
@@ -24,7 +24,9 @@ import org.apache.lucene.store.IndexInput;
  * An {@link InputStream} which wraps an {@link IndexInput}.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public final class IndexInputInputStream extends InputStream {
 
   private final IndexInput in;
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexReplicationHandler.java b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexReplicationHandler.java
index e9db15696fe..bd350c1c93f 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexReplicationHandler.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexReplicationHandler.java
@@ -51,7 +51,9 @@ import org.apache.lucene.util.InfoStream;
  * commit was made available for it.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class IndexReplicationHandler implements ReplicationHandler {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexRevision.java b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexRevision.java
index c649e4aa7a5..8b5af885ef9 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/IndexRevision.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/IndexRevision.java
@@ -43,7 +43,9 @@ import org.apache.lucene.store.IOContext;
  * they are no longer needed).
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class IndexRevision implements Revision {
 
   private static final int RADIX = 16;
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/LocalReplicator.java b/lucene/replicator/src/java/org/apache/lucene/replicator/LocalReplicator.java
index fe519d07113..8c95b800ce5 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/LocalReplicator.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/LocalReplicator.java
@@ -36,7 +36,9 @@ import org.apache.lucene.store.AlreadyClosedException;
  * and the threshold can be configured through {@link #setExpirationThreshold(long)}.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class LocalReplicator implements Replicator {
 
   private static class RefCountedRevision {
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/PerSessionDirectoryFactory.java b/lucene/replicator/src/java/org/apache/lucene/replicator/PerSessionDirectoryFactory.java
index adb351ff901..073ccc6a6f3 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/PerSessionDirectoryFactory.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/PerSessionDirectoryFactory.java
@@ -29,7 +29,9 @@ import org.apache.lucene.util.IOUtils;
  * directory. When a session is over, the entire directory is deleted.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class PerSessionDirectoryFactory implements SourceDirectoryFactory {
 
   private final Path workDir;
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/ReplicationClient.java b/lucene/replicator/src/java/org/apache/lucene/replicator/ReplicationClient.java
index 54626051a6f..2008c57fe2c 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/ReplicationClient.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/ReplicationClient.java
@@ -49,7 +49,9 @@ import org.apache.lucene.util.ThreadInterruptedException;
  * Directory} specified by {@link PerSessionDirectoryFactory} and a handler is notified.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class ReplicationClient implements Closeable {
 
   private class ReplicationThread extends Thread {
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/Replicator.java b/lucene/replicator/src/java/org/apache/lucene/replicator/Replicator.java
index 32fb68eb4d2..0bd81d07459 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/Replicator.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/Replicator.java
@@ -33,7 +33,9 @@ import java.io.InputStream;
  * cllient will next check for update, it will receive <em>r3</em>.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public interface Replicator extends Closeable {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/Revision.java b/lucene/replicator/src/java/org/apache/lucene/replicator/Revision.java
index 20c4c8e8454..113944acc59 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/Revision.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/Revision.java
@@ -32,7 +32,9 @@ import org.apache.lucene.store.IndexInput;
  * indexes together, to guarantee that they match at the client side.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public interface Revision extends Comparable<Revision> {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/RevisionFile.java b/lucene/replicator/src/java/org/apache/lucene/replicator/RevisionFile.java
index 101cbde65fa..dbfb9ac1b68 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/RevisionFile.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/RevisionFile.java
@@ -21,7 +21,9 @@ package org.apache.lucene.replicator;
  * contain files from multiple sources (e.g. multiple indexes).
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class RevisionFile {
 
   /** The name of the file. */
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java
index 81fa3dbc986..75a63ee18f8 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionExpiredException.java
@@ -24,7 +24,9 @@ import java.io.IOException;
  * @see LocalReplicator#DEFAULT_SESSION_EXPIRATION_THRESHOLD
  * @see LocalReplicator#setExpirationThreshold(long)
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class SessionExpiredException extends IOException {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java
index d359ea140d9..cf30a5bb16e 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/SessionToken.java
@@ -33,7 +33,9 @@ import java.util.Map.Entry;
  * @see Replicator#release(String)
  * @see LocalReplicator#DEFAULT_SESSION_EXPIRATION_THRESHOLD
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public final class SessionToken {
 
   /**
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpClientBase.java b/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpClientBase.java
index 315eff1a0ed..4793059971a 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpClientBase.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpClientBase.java
@@ -42,7 +42,9 @@ import org.apache.lucene.util.SuppressForbidden;
  * Base class for Http clients.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public abstract class HttpClientBase implements Closeable {
 
   /** Default connection timeout for this client, in milliseconds. */
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpReplicator.java b/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpReplicator.java
index dd12172d983..eabe96b48c1 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpReplicator.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/http/HttpReplicator.java
@@ -32,7 +32,9 @@ import org.apache.lucene.replicator.http.ReplicationService.ReplicationAction;
  * ReplicationService}.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class HttpReplicator extends HttpClientBase implements Replicator {
 
   /** Construct with specified connection manager. */
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/http/ReplicationService.java b/lucene/replicator/src/java/org/apache/lucene/replicator/http/ReplicationService.java
index a511cd47af3..4617bcacf98 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/http/ReplicationService.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/http/ReplicationService.java
@@ -52,7 +52,9 @@ import org.apache.lucene.util.SuppressForbidden;
  * embed in your application's servlet.
  *
  * @lucene.experimental
+ * @deprecated use org.apache.lucene.replicator.nrt instead
  */
+@Deprecated
 public class ReplicationService {
 
   /** Actions supported by the {@link ReplicationService}. */
diff --git a/lucene/replicator/src/java/org/apache/lucene/replicator/http/package-info.java b/lucene/replicator/src/java/org/apache/lucene/replicator/http/package-info.java
index fc19fd5725a..d1c9789ed5f 100644
--- a/lucene/replicator/src/java/org/apache/lucene/replicator/http/package-info.java
+++ b/lucene/replicator/src/java/org/apache/lucene/replicator/http/package-info.java
@@ -15,5 +15,9 @@
  * limitations under the License.
  */
 
-/** HTTP replication implementation */
+/**
+ * HTTP replication implementation
+ *
+ * @deprecated use org.apache.lucene.replicator.nrt instead
+ */
 package org.apache.lucene.replicator.http;