mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 13:08:29 +00:00
944972a249
The EmptyResponse is essentially the same as returning a boolean, which is done in other places. This commit deprecates all the existing EmptyResponse methods and creates new boolean methods that have method params reordered so they can exist with the deprecated methods. A followup PR in master will remove the existing deprecated methods, fix the parameter ordering and deprecate the incorrectly ordered parameter methods. Relates #36938
46 lines
1.7 KiB
Plaintext
46 lines
1.7 KiB
Plaintext
[[java-rest-high-security-enable-user]]
|
|
=== Enable User API
|
|
|
|
[[java-rest-high-security-enable-user-execution]]
|
|
==== Execution
|
|
|
|
Enabling a disabled user can be performed using the `security().enableUser()`
|
|
method:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[enable-user-execute]
|
|
--------------------------------------------------
|
|
|
|
[[java-rest-high-security-enable-user-response]]
|
|
==== Response
|
|
|
|
The returned `Boolean` indicates the request status.
|
|
|
|
[[java-rest-high-security-enable-user-async]]
|
|
==== Asynchronous Execution
|
|
|
|
This request can be executed asynchronously:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[enable-user-execute-async]
|
|
--------------------------------------------------
|
|
<1> The `EnableUser` request to execute and the `ActionListener` to use when
|
|
the execution completes.
|
|
|
|
The asynchronous method does not block and returns immediately. Once the request
|
|
has completed the `ActionListener` is called back using the `onResponse` method
|
|
if the execution successfully completed or using the `onFailure` method if
|
|
it failed.
|
|
|
|
A typical listener for a `Boolean` looks like:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests}/SecurityDocumentationIT.java[enable-user-execute-listener]
|
|
--------------------------------------------------
|
|
<1> Called when the execution is successfully completed. The response is
|
|
provided as an argument.
|
|
<2> Called in case of failure. The raised exception is provided as an argument.
|