Deprecate HLRC security methods (#37883)

This commit deprecates the few methods that had their parameters
reordered to facilitate the move from EmptyResponse to boolean. This
commit also readds the boolean based methods with the proper
signatures.

Relates #37540
Relates #36938

Author: hub-cap

client/rest-high-level/src/main/java/org/elasticsearch/client/SecurityClient.java

@@ -38,7 +38,6 @@
 import org.elasticsearch.client.security.DeleteUserRequest;
 import org.elasticsearch.client.security.DeleteUserResponse;
 import org.elasticsearch.client.security.DisableUserRequest;
-import org.elasticsearch.client.security.EmptyResponse;
 import org.elasticsearch.client.security.EnableUserRequest;
 import org.elasticsearch.client.security.GetPrivilegesRequest;
 import org.elasticsearch.client.security.GetPrivilegesResponse;
@@ -235,14 +234,12 @@ public void getRoleMappingsAsync(final GetRoleMappingsRequest request, final Req
      *
      * @param request the request with the user to enable
      * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
-     * @return the response from the enable user call
+     * @return {@code true} if the request succeeded (the user is enabled)
      * @throws IOException in case there is a problem sending the request or parsing back the response
-     * @deprecated use {@link #enableUser(RequestOptions, EnableUserRequest)} instead
      */
-    @Deprecated
-    public EmptyResponse enableUser(EnableUserRequest request, RequestOptions options) throws IOException {
-        return restHighLevelClient.performRequestAndParseEntity(request, SecurityRequestConverters::enableUser, options,
-            EmptyResponse::fromXContent, emptySet());
+    public boolean enableUser(EnableUserRequest request, RequestOptions options) throws IOException {
+        return restHighLevelClient.performRequest(request, SecurityRequestConverters::enableUser, options,
+            RestHighLevelClient::convertExistsResponse, emptySet());
     }
 
     /**
@@ -254,10 +251,11 @@ public EmptyResponse enableUser(EnableUserRequest request, RequestOptions option
      * @param request the request with the user to enable
      * @return {@code true} if the request succeeded (the user is enabled)
      * @throws IOException in case there is a problem sending the request or parsing back the response
+     * @deprecated use {@link #enableUser(EnableUserRequest, RequestOptions)} instead
      */
+    @Deprecated
     public boolean enableUser(RequestOptions options, EnableUserRequest request) throws IOException {
-        return restHighLevelClient.performRequest(request, SecurityRequestConverters::enableUser, options,
-            RestHighLevelClient::convertExistsResponse, emptySet());
+        return enableUser(request, options);
     }
 
     /**
@@ -268,13 +266,11 @@ public boolean enableUser(RequestOptions options, EnableUserRequest request) thr
      * @param request  the request with the user to enable
      * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @param listener the listener to be notified upon request completion
-     * @deprecated use {@link #enableUserAsync(RequestOptions, EnableUserRequest, ActionListener)} instead
      */
-    @Deprecated
     public void enableUserAsync(EnableUserRequest request, RequestOptions options,
-                                ActionListener<EmptyResponse> listener) {
-        restHighLevelClient.performRequestAsyncAndParseEntity(request, SecurityRequestConverters::enableUser, options,
-            EmptyResponse::fromXContent, listener, emptySet());
+                                ActionListener<Boolean> listener) {
+        restHighLevelClient.performRequestAsync(request, SecurityRequestConverters::enableUser, options,
+            RestHighLevelClient::convertExistsResponse, listener, emptySet());
     }
 
     /**
@@ -285,11 +281,12 @@ public void enableUserAsync(EnableUserRequest request, RequestOptions options,
      * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @param request  the request with the user to enable
      * @param listener the listener to be notified upon request completion
+     * @deprecated use {@link #enableUserAsync(EnableUserRequest, RequestOptions, ActionListener)} instead
      */
+    @Deprecated
     public void enableUserAsync(RequestOptions options, EnableUserRequest request,
                                 ActionListener<Boolean> listener) {
-        restHighLevelClient.performRequestAsync(request, SecurityRequestConverters::enableUser, options,
-            RestHighLevelClient::convertExistsResponse, listener, emptySet());
+        enableUserAsync(request, options, listener);
     }
 
     /**
@@ -299,14 +296,12 @@ public void enableUserAsync(RequestOptions options, EnableUserRequest request,
      *
      * @param request the request with the user to disable
      * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
-     * @return the response from the enable user call
+     * @return {@code true} if the request succeeded (the user is disabled)
      * @throws IOException in case there is a problem sending the request or parsing back the response
-     * @deprecated use {@link #disableUser(RequestOptions, DisableUserRequest)} instead
      */
-    @Deprecated
-    public EmptyResponse disableUser(DisableUserRequest request, RequestOptions options) throws IOException {
-        return restHighLevelClient.performRequestAndParseEntity(request, SecurityRequestConverters::disableUser, options,
-            EmptyResponse::fromXContent, emptySet());
+    public boolean disableUser(DisableUserRequest request, RequestOptions options) throws IOException {
+        return restHighLevelClient.performRequest(request, SecurityRequestConverters::disableUser, options,
+            RestHighLevelClient::convertExistsResponse, emptySet());
     }
 
     /**
@@ -318,10 +313,11 @@ public EmptyResponse disableUser(DisableUserRequest request, RequestOptions opti
      * @param request the request with the user to disable
      * @return {@code true} if the request succeeded (the user is disabled)
      * @throws IOException in case there is a problem sending the request or parsing back the response
+     * @deprecated use {@link #disableUser(DisableUserRequest, RequestOptions)} instead
      */
+    @Deprecated
     public boolean disableUser(RequestOptions options, DisableUserRequest request) throws IOException {
-        return restHighLevelClient.performRequest(request, SecurityRequestConverters::disableUser, options,
-            RestHighLevelClient::convertExistsResponse, emptySet());
+        return disableUser(request, options);
     }
 
     /**
@@ -332,13 +328,11 @@ public boolean disableUser(RequestOptions options, DisableUserRequest request) t
      * @param request  the request with the user to disable
      * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @param listener the listener to be notified upon request completion
-     * @deprecated use {@link #disableUserAsync(RequestOptions, DisableUserRequest, ActionListener)} instead
      */
-    @Deprecated
     public void disableUserAsync(DisableUserRequest request, RequestOptions options,
-                                 ActionListener<EmptyResponse> listener) {
-        restHighLevelClient.performRequestAsyncAndParseEntity(request, SecurityRequestConverters::disableUser, options,
-            EmptyResponse::fromXContent, listener, emptySet());
+                                 ActionListener<Boolean> listener) {
+        restHighLevelClient.performRequestAsync(request, SecurityRequestConverters::disableUser, options,
+            RestHighLevelClient::convertExistsResponse, listener, emptySet());
     }
 
     /**
@@ -349,11 +343,12 @@ public void disableUserAsync(DisableUserRequest request, RequestOptions options,
      * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @param request  the request with the user to disable
      * @param listener the listener to be notified upon request completion
+     * @deprecated use {@link #disableUserAsync(DisableUserRequest, RequestOptions, ActionListener)} instead
      */
+    @Deprecated
     public void disableUserAsync(RequestOptions options, DisableUserRequest request,
                                  ActionListener<Boolean> listener) {
-        restHighLevelClient.performRequestAsync(request, SecurityRequestConverters::disableUser, options,
-            RestHighLevelClient::convertExistsResponse, listener, emptySet());
+        disableUserAsync(request, options, listener);
     }
 
     /**
@@ -523,14 +518,12 @@ public void getSslCertificatesAsync(RequestOptions options, ActionListener<GetSs
      *
      * @param request the request with the user's new password
      * @param options the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
-     * @return the response from the change user password call
+     * @return {@code true} if the request succeeded (the new password was set)
      * @throws IOException in case there is a problem sending the request or parsing back the response
-     * @deprecated use {@link #changePassword(RequestOptions, ChangePasswordRequest)} instead
      */
-    @Deprecated
-    public EmptyResponse changePassword(ChangePasswordRequest request, RequestOptions options) throws IOException {
-        return restHighLevelClient.performRequestAndParseEntity(request, SecurityRequestConverters::changePassword, options,
-            EmptyResponse::fromXContent, emptySet());
+    public boolean changePassword(ChangePasswordRequest request, RequestOptions options) throws IOException {
+        return restHighLevelClient.performRequest(request, SecurityRequestConverters::changePassword, options,
+            RestHighLevelClient::convertExistsResponse, emptySet());
     }
 
     /**
@@ -542,10 +535,11 @@ public EmptyResponse changePassword(ChangePasswordRequest request, RequestOption
      * @param request the request with the user's new password
      * @return {@code true} if the request succeeded (the new password was set)
      * @throws IOException in case there is a problem sending the request or parsing back the response
+     * @deprecated use {@link #changePassword(ChangePasswordRequest, RequestOptions)} instead
      */
+    @Deprecated
     public boolean changePassword(RequestOptions options, ChangePasswordRequest request) throws IOException {
-        return restHighLevelClient.performRequest(request, SecurityRequestConverters::changePassword, options,
-            RestHighLevelClient::convertExistsResponse, emptySet());
+        return changePassword(request, options);
     }
 
     /**
@@ -556,13 +550,11 @@ public boolean changePassword(RequestOptions options, ChangePasswordRequest requ
      * @param request  the request with the user's new password
      * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @param listener the listener to be notified upon request completion
-     * @deprecated use {@link #changePasswordAsync(RequestOptions, ChangePasswordRequest, ActionListener)} instead
      */
-    @Deprecated
     public void changePasswordAsync(ChangePasswordRequest request, RequestOptions options,
-                                    ActionListener<EmptyResponse> listener) {
-        restHighLevelClient.performRequestAsyncAndParseEntity(request, SecurityRequestConverters::changePassword, options,
-            EmptyResponse::fromXContent, listener, emptySet());
+                                    ActionListener<Boolean> listener) {
+        restHighLevelClient.performRequestAsync(request, SecurityRequestConverters::changePassword, options,
+            RestHighLevelClient::convertExistsResponse, listener, emptySet());
     }
 
     /**
@@ -573,14 +565,14 @@ public void changePasswordAsync(ChangePasswordRequest request, RequestOptions op
      * @param options  the request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
      * @param request  the request with the user's new password
      * @param listener the listener to be notified upon request completion
+     * @deprecated use {@link #changePasswordAsync(ChangePasswordRequest, RequestOptions, ActionListener)} instead
      */
+    @Deprecated
     public void changePasswordAsync(RequestOptions options, ChangePasswordRequest request,
                                     ActionListener<Boolean> listener) {
-        restHighLevelClient.performRequestAsync(request, SecurityRequestConverters::changePassword, options,
-            RestHighLevelClient::convertExistsResponse, listener, emptySet());
+        changePasswordAsync(request, options, listener);
     }
 
-
     /**
      * Delete a role mapping.
      * See <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html">

client/rest-high-level/src/main/java/org/elasticsearch/client/security/EmptyResponse.java

@@ -517,7 +517,7 @@ public void testEnableUser() throws Exception {
         {
             //tag::enable-user-execute
             EnableUserRequest request = new EnableUserRequest("enable_user", RefreshPolicy.NONE);
-            boolean response = client.security().enableUser(RequestOptions.DEFAULT, request);
+            boolean response = client.security().enableUser(request, RequestOptions.DEFAULT);
             //end::enable-user-execute
 
             assertTrue(response);
@@ -544,7 +544,7 @@ public void onFailure(Exception e) {
             listener = new LatchedActionListener<>(listener, latch);
 
             // tag::enable-user-execute-async
-            client.security().enableUserAsync(RequestOptions.DEFAULT, request, listener); // <1>
+            client.security().enableUserAsync(request, RequestOptions.DEFAULT, listener); // <1>
             // end::enable-user-execute-async
 
             assertTrue(latch.await(30L, TimeUnit.SECONDS));
@@ -561,7 +561,7 @@ public void testDisableUser() throws Exception {
         {
             //tag::disable-user-execute
             DisableUserRequest request = new DisableUserRequest("disable_user", RefreshPolicy.NONE);
-            boolean response = client.security().disableUser(RequestOptions.DEFAULT, request);
+            boolean response = client.security().disableUser(request, RequestOptions.DEFAULT);
             //end::disable-user-execute
 
             assertTrue(response);
@@ -588,7 +588,7 @@ public void onFailure(Exception e) {
             listener = new LatchedActionListener<>(listener, latch);
 
             // tag::disable-user-execute-async
-            client.security().disableUserAsync(RequestOptions.DEFAULT, request, listener); // <1>
+            client.security().disableUserAsync(request, RequestOptions.DEFAULT, listener); // <1>
             // end::disable-user-execute-async
 
             assertTrue(latch.await(30L, TimeUnit.SECONDS));
@@ -1038,7 +1038,7 @@ public void testChangePassword() throws Exception {
         {
             //tag::change-password-execute
             ChangePasswordRequest request = new ChangePasswordRequest("change_password_user", newPassword, RefreshPolicy.NONE);
-            boolean response = client.security().changePassword(RequestOptions.DEFAULT, request);
+            boolean response = client.security().changePassword(request, RequestOptions.DEFAULT);
             //end::change-password-execute
 
             assertTrue(response);
@@ -1064,7 +1064,7 @@ public void onFailure(Exception e) {
             listener = new LatchedActionListener<>(listener, latch);
 
             //tag::change-password-execute-async
-            client.security().changePasswordAsync(RequestOptions.DEFAULT, request, listener); // <1>
+            client.security().changePasswordAsync(request, RequestOptions.DEFAULT, listener); // <1>
             //end::change-password-execute-async
 
             assertTrue(latch.await(30L, TimeUnit.SECONDS));