github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 23:27:25 -04:00
Code Issues Projects Releases Packages Wiki Activity

[HLRC] Add support for get role mappings API (#34637)

Browse source 
This commit adds support for get role mappings API
in HLRC.
This commit is contained in:
Yogesh Gaikwad 2018-10-29 10:12:13 +11:00 • committed by GitHub
parent 4e5c305225
commit a5ee134c40
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 845 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

67
docs/java-rest/high-level/security/get-role-mappings.asciidoc Normal file
View file

@ -0,0 +1,67 @@
[[java-rest-high-security-get-role-mappings]]
=== Get Role Mappings API
[[java-rest-high-security-get-role-mappings-execution]]
==== Execution
Retrieving a role mapping can be performed using the `security().getRoleMappings()`
method and by setting role mapping name on `GetRoleMappingsRequest`:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SecurityDocumentationIT.java[get-role-mappings-execute]
--------------------------------------------------
Retrieving multiple role mappings can be performed using the `security.getRoleMappings()`
method and by setting role mapping names on `GetRoleMappingsRequest`:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SecurityDocumentationIT.java[get-role-mappings-list-execute]
--------------------------------------------------
Retrieving all role mappings can be performed using the `security.getRoleMappings()`
method and with no role mapping name on `GetRoleMappingsRequest`:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SecurityDocumentationIT.java[get-role-mappings-all-execute]
--------------------------------------------------
[[java-rest-high-security-get-role-mappings-response]]
==== Response
The returned `GetRoleMappingsResponse` contains the list of role mapping(s).
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SecurityDocumentationIT.java[get-role-mappings-response]
--------------------------------------------------
[[java-rest-high-security-get-role-mappings-async]]
==== Asynchronous Execution
This request can be executed asynchronously using the `security().getRoleMappingsAsync()`
method:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SecurityDocumentationIT.java[get-role-mappings-execute-async]
--------------------------------------------------
<1> The `GetRoleMappingsRequest` 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 `GetRoleMappingsResponse` looks like:
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests}/SecurityDocumentationIT.java[get-role-mappings-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

2
docs/java-rest/high-level/supported-apis.asciidoc
View file

@ -327,6 +327,7 @@ The Java High Level REST Client supports the following Security APIs:
* <<{upid}-clear-roles-cache>>
* <<java-rest-high-security-get-certificates>>
* <<java-rest-high-security-put-role-mapping>>
* <<java-rest-high-security-get-role-mapping>>
* <<java-rest-high-security-delete-role-mapping>>
include::security/put-user.asciidoc[]
@ -337,6 +338,7 @@ include::security/delete-role.asciidoc[]
include::security/clear-roles-cache.asciidoc[]
include::security/get-certificates.asciidoc[]
include::security/put-role-mapping.asciidoc[]
include::security/get-role-mapping.asciidoc[]
include::security/delete-role-mapping.asciidoc[]
== Watcher APIs