Add all deprecated method in the package with new name 'org.opensearc…

…h.action.support.clustermanager' (#3644) Signed-off-by: Tianli Feng <[email protected]>
opensearch-project · Jun 22, 2022 · 621cee9 · 621cee9
1 parent 3dba46e
commit 621cee9
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 69 deletions.
diff --git a/...g/opensearch/action/support/clustermanager/ClusterManagerNodeOperationRequestBuilder.java b/...g/opensearch/action/support/clustermanager/ClusterManagerNodeOperationRequestBuilder.java
@@ -63,6 +63,17 @@ public final RequestBuilder setClusterManagerNodeTimeout(TimeValue timeout) {
         return (RequestBuilder) this;
     }
 
+    /**
+     * Sets the cluster-manager node timeout in case the cluster-manager has not yet been discovered.
+     *
+     * @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #setClusterManagerNodeTimeout(TimeValue)}
+     */
+    @SuppressWarnings("unchecked")
+    @Deprecated
+    public final RequestBuilder setMasterNodeTimeout(TimeValue timeout) {
+        return setClusterManagerNodeTimeout(timeout);
+    }
+
     /**
      * Sets the cluster-manager node timeout in case the cluster-manager has not yet been discovered.
      */
@@ -72,4 +83,14 @@ public final RequestBuilder setClusterManagerNodeTimeout(String timeout) {
         return (RequestBuilder) this;
     }
 
+    /**
+     * Sets the cluster-manager node timeout in case the cluster-manager has not yet been discovered.
+     *
+     * @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #setClusterManagerNodeTimeout(String)}
+     */
+    @SuppressWarnings("unchecked")
+    @Deprecated
+    public final RequestBuilder setMasterNodeTimeout(String timeout) {
+        return setClusterManagerNodeTimeout(timeout);
+    }
 }
diff --git a/...src/main/java/org/opensearch/action/support/clustermanager/ClusterManagerNodeRequest.java b/...src/main/java/org/opensearch/action/support/clustermanager/ClusterManagerNodeRequest.java
@@ -48,8 +48,16 @@ public abstract class ClusterManagerNodeRequest<Request extends ClusterManagerNo
 
     public static final TimeValue DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT = TimeValue.timeValueSeconds(30);
 
+    /** @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT} */
+    @Deprecated
+    public static final TimeValue DEFAULT_MASTER_NODE_TIMEOUT = DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT;
+
     protected TimeValue clusterManagerNodeTimeout = DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT;
 
+    /** @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerNodeTimeout} */
+    @Deprecated
+    protected TimeValue masterNodeTimeout = clusterManagerNodeTimeout;
+
     protected ClusterManagerNodeRequest() {}
 
     protected ClusterManagerNodeRequest(StreamInput in) throws IOException {
@@ -72,6 +80,17 @@ public final Request clusterManagerNodeTimeout(TimeValue timeout) {
         return (Request) this;
     }
 
+    /**
+     * A timeout value in case the cluster-manager has not been discovered yet or disconnected.
+     *
+     * @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerNodeTimeout(TimeValue)}
+     */
+    @SuppressWarnings("unchecked")
+    @Deprecated
+    public final Request masterNodeTimeout(TimeValue timeout) {
+        return clusterManagerNodeTimeout(timeout);
+    }
+
     /**
      * A timeout value in case the cluster-manager has not been discovered yet or disconnected.
      */
@@ -81,11 +100,20 @@ public final Request clusterManagerNodeTimeout(String timeout) {
         );
     }
 
+    /**
+     * A timeout value in case the cluster-manager has not been discovered yet or disconnected.
+     *
+     * @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerNodeTimeout(String)}
+     */
+    @Deprecated
+    public final Request masterNodeTimeout(String timeout) {
+        return clusterManagerNodeTimeout(timeout);
+    }
+
     public final TimeValue clusterManagerNodeTimeout() {
         return this.clusterManagerNodeTimeout;
     }
 
-    // Preserve the method so that classes implements AcknowledgedRequest don't need to override it for backwards compatibility.
     /** @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerNodeTimeout()} */
     @Deprecated
     public final TimeValue masterNodeTimeout() {

diff --git a/.../java/org/opensearch/action/support/clustermanager/TransportClusterManagerNodeAction.java b/.../java/org/opensearch/action/support/clustermanager/TransportClusterManagerNodeAction.java
@@ -120,8 +120,7 @@ protected TransportClusterManagerNodeAction(
     protected abstract void clusterManagerOperation(Request request, ClusterState state, ActionListener<Response> listener)
         throws Exception;
 
-    // Preserve the method so that o.o.action.support.master.info.TransportClusterInfoAction class
-    // can override masterOperation() for backwards compatibility.
+    // Change the method to be concrete after deprecation so that existing class can override it while new class don't have to.
     /** @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerOperation(ClusterManagerNodeRequest, ClusterState, ActionListener)} */
     @Deprecated
     protected void masterOperation(Request request, ClusterState state, ActionListener<Response> listener) throws Exception {
@@ -136,6 +135,16 @@ protected void clusterManagerOperation(Task task, Request request, ClusterState
         clusterManagerOperation(request, state, listener);
     }
 
+    /**
+     * Override this operation if access to the task parameter is needed
+     *
+     * @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerOperation(Task, ClusterManagerNodeRequest, ClusterState, ActionListener)}
+     */
+    @Deprecated
+    protected void masterOperation(Task task, Request request, ClusterState state, ActionListener<Response> listener) throws Exception {
+        clusterManagerOperation(task, request, state, listener);
+    }
+
     protected boolean localExecute(Request request) {
         return false;
     }
@@ -303,4 +312,15 @@ public void onTimeout(TimeValue timeout) {
     protected String getClusterManagerActionName(DiscoveryNode node) {
         return actionName;
     }
+
+    /**
+     * Allows to conditionally return a different cluster-manager node action name in the case an action gets renamed.
+     * This mainly for backwards compatibility should be used rarely
+     *
+     * @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #getClusterManagerActionName(DiscoveryNode)}
+     */
+    @Deprecated
+    protected String getMasterActionName(DiscoveryNode node) {
+        return getClusterManagerActionName(node);
+    }
 }
diff --git a/...in/java/org/opensearch/action/support/clustermanager/info/TransportClusterInfoAction.java b/...in/java/org/opensearch/action/support/clustermanager/info/TransportClusterInfoAction.java
@@ -82,10 +82,24 @@ protected final void clusterManagerOperation(final Request request, final Cluste
         doClusterManagerOperation(request, concreteIndices, state, listener);
     }
 
+    /** @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #clusterManagerOperation(ClusterInfoRequest, ClusterState, ActionListener)} */
+    @Deprecated
+    @Override
+    protected final void masterOperation(final Request request, final ClusterState state, final ActionListener<Response> listener) {
+        clusterManagerOperation(request, state, listener);
+    }
+
     protected abstract void doClusterManagerOperation(
         Request request,
         String[] concreteIndices,
         ClusterState state,
         ActionListener<Response> listener
     );
+
+    // Change the method to be concrete after deprecation so that existing class can override it while new class don't have to.
+    /** @deprecated As of 2.1, because supporting inclusive language, replaced by {@link #doClusterManagerOperation(ClusterInfoRequest, String[], ClusterState, ActionListener)} */
+    @Deprecated
+    protected void doMasterOperation(Request request, String[] concreteIndices, ClusterState state, ActionListener<Response> listener) {
+        doClusterManagerOperation(request, concreteIndices, state, listener);
+    }
 }
diff --git a/...src/main/java/org/opensearch/action/support/master/MasterNodeOperationRequestBuilder.java b/...src/main/java/org/opensearch/action/support/master/MasterNodeOperationRequestBuilder.java
@@ -37,7 +37,6 @@
 import org.opensearch.action.support.clustermanager.ClusterManagerNodeOperationRequestBuilder;
 import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest;
 import org.opensearch.client.OpenSearchClient;
-import org.opensearch.common.unit.TimeValue;
 
 /**
  * Base request builder for cluster-manager node operations
@@ -55,22 +54,4 @@ public abstract class MasterNodeOperationRequestBuilder<
     protected MasterNodeOperationRequestBuilder(OpenSearchClient client, ActionType<Response> action, Request request) {
         super(client, action, request);
     }
-
-    /**
-     * Sets the cluster-manager node timeout in case the cluster-manager has not yet been discovered.
-     */
-    @SuppressWarnings("unchecked")
-    @Deprecated
-    public final RequestBuilder setMasterNodeTimeout(TimeValue timeout) {
-        return setClusterManagerNodeTimeout(timeout);
-    }
-
-    /**
-     * Sets the cluster-manager node timeout in case the cluster-manager has not yet been discovered.
-     */
-    @SuppressWarnings("unchecked")
-    @Deprecated
-    public final RequestBuilder setMasterNodeTimeout(String timeout) {
-        return setClusterManagerNodeTimeout(timeout);
-    }
 }
diff --git a/server/src/main/java/org/opensearch/action/support/master/MasterNodeRequest.java b/server/src/main/java/org/opensearch/action/support/master/MasterNodeRequest.java
@@ -34,7 +34,6 @@
 
 import org.opensearch.action.support.clustermanager.ClusterManagerNodeRequest;
 import org.opensearch.common.io.stream.StreamInput;
-import org.opensearch.common.unit.TimeValue;
 
 import java.io.IOException;
 
@@ -47,30 +46,7 @@
 @Deprecated
 public abstract class MasterNodeRequest<Request extends MasterNodeRequest<Request>> extends ClusterManagerNodeRequest<Request> {
 
-    @Deprecated
-    public static final TimeValue DEFAULT_MASTER_NODE_TIMEOUT = DEFAULT_CLUSTER_MANAGER_NODE_TIMEOUT;
-
-    @Deprecated
-    protected TimeValue masterNodeTimeout = clusterManagerNodeTimeout;
-
     protected MasterNodeRequest(StreamInput in) throws IOException {
         super(in);
     }
-
-    /**
-     * A timeout value in case the cluster-manager has not been discovered yet or disconnected.
-     */
-    @SuppressWarnings("unchecked")
-    @Deprecated
-    public final Request masterNodeTimeout(TimeValue timeout) {
-        return clusterManagerNodeTimeout(timeout);
-    }
-
-    /**
-     * A timeout value in case the cluster-manager has not been discovered yet or disconnected.
-     */
-    @Deprecated
-    public final Request masterNodeTimeout(String timeout) {
-        return clusterManagerNodeTimeout(timeout);
-    }
 }
diff --git a/server/src/main/java/org/opensearch/action/support/master/TransportMasterNodeAction.java b/server/src/main/java/org/opensearch/action/support/master/TransportMasterNodeAction.java
@@ -39,10 +39,8 @@
 import org.opensearch.action.support.clustermanager.TransportClusterManagerNodeAction;
 import org.opensearch.cluster.ClusterState;
 import org.opensearch.cluster.metadata.IndexNameExpressionResolver;
-import org.opensearch.cluster.node.DiscoveryNode;
 import org.opensearch.cluster.service.ClusterService;
 import org.opensearch.common.io.stream.Writeable;
-import org.opensearch.tasks.Task;
 import org.opensearch.threadpool.ThreadPool;
 import org.opensearch.transport.TransportService;
 
@@ -93,20 +91,4 @@ protected TransportMasterNodeAction(
     @Deprecated
     protected abstract void masterOperation(Request request, ClusterState state, ActionListener<Response> listener) throws Exception;
 
-    /**
-     * Override this operation if access to the task parameter is needed
-     */
-    @Deprecated
-    protected void masterOperation(Task task, Request request, ClusterState state, ActionListener<Response> listener) throws Exception {
-        clusterManagerOperation(task, request, state, listener);
-    }
-
-    /**
-     * Allows to conditionally return a different cluster-manager node action name in the case an action gets renamed.
-     * This mainly for backwards compatibility should be used rarely
-     */
-    @Deprecated
-    protected String getMasterActionName(DiscoveryNode node) {
-        return getClusterManagerActionName(node);
-    }
 }
diff --git a/...r/src/main/java/org/opensearch/action/support/master/info/TransportClusterInfoAction.java b/...r/src/main/java/org/opensearch/action/support/master/info/TransportClusterInfoAction.java
@@ -61,11 +61,6 @@ public TransportClusterInfoAction(
         super(actionName, transportService, clusterService, threadPool, actionFilters, request, indexNameExpressionResolver);
     }
 
-    @Deprecated
-    protected final void masterOperation(final Request request, final ClusterState state, final ActionListener<Response> listener) {
-        clusterManagerOperation(request, state, listener);
-    }
-
     @Deprecated
     protected abstract void doMasterOperation(
         Request request,