[HLRC] Add support for get roles API#35787
Merged
jkakavas merged 16 commits intoelastic:masterfrom Nov 26, 2018
Merged
Conversation
TODO: Implement GetRolesResponse once suppporting classes for roles are commited
Collaborator
|
Pinging @elastic/es-security |
bizybot
approved these changes
Nov 22, 2018
Contributor
bizybot
left a comment
There was a problem hiding this comment.
LGTM, few comments once addressed, good to go. Thank you.
client/rest-high-level/src/main/java/org/elasticsearch/client/security/GetRolesResponse.java
Show resolved
Hide resolved
...high-level/src/test/java/org/elasticsearch/client/documentation/SecurityDocumentationIT.java
Outdated
Show resolved
Hide resolved
Contributor
Author
|
Thanks for the feedback @bizybot |
| } | ||
|
|
||
| /** | ||
| * Retrieves roles in the native realm. |
Contributor
There was a problem hiding this comment.
IMO s/native realm/native roles store/
(I know this comment uses the lingo from the docs)
| builder.addPathPart(Strings.collectionToCommaDelimitedString(getRolesRequest.getRoleNames())); | ||
| } | ||
| return new Request(HttpGet.METHOD_NAME, builder.build()); | ||
|
|
| import java.util.Set; | ||
|
|
||
| /** | ||
| * Request object to retrieve roles from the security index |
Contributor
There was a problem hiding this comment.
IMO s/security index/native roles store
| XContentParser.Token token; | ||
| while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) { | ||
| XContentParserUtils.ensureExpectedToken(XContentParser.Token.FIELD_NAME, token, parser::getTokenLocation); | ||
| roles.add(Role.PARSER.parse(parser, null)); |
Contributor
There was a problem hiding this comment.
I think we lose the role name here. The Role should have a name.
For this, the Role#fromXContent could have a name parameter and be called here ; and not implement ToXContentObject (PutRole would build the XContent).
Contributor
There was a problem hiding this comment.
Nice catch, I agree to have optional name parameter to Role#fromXContent (the javadocs for the Role will need an update)
| PARSER.declareFieldArray(optionalConstructorArg(), ApplicationResourcePrivileges.PARSER, APPLICATIONS, ValueType.OBJECT_ARRAY); | ||
| PARSER.declareStringArray(optionalConstructorArg(), RUN_AS); | ||
| PARSER.declareObject(constructorArg(), (parser, c) -> parser.map(), METADATA); | ||
| PARSER.declareObject(optionalConstructorArg(), (parser, c) -> parser.map(), TRANSIENT_METADATA); |
Contributor
There was a problem hiding this comment.
Is there a difference between metadata and transient_metadata ? If not I would make them both either optionalConstructorArg (cautious) or constructorArg (confident) :)
albertzaharovits
requested changes
Nov 23, 2018
Contributor
albertzaharovits
left a comment
There was a problem hiding this comment.
I have recommended that the Role have a name despite the idiosyncratic Response making it hard.
From the client perspective, it's cumbersome to manipulate a list of roles, from the response, in the order of the role names that have been requested. I would argue that returning a Collection with Roles having a name as attribute follows closer the encapsulation precept.
albertzaharovits
approved these changes
Nov 23, 2018
...nt/rest-high-level/src/main/java/org/elasticsearch/client/security/user/privileges/Role.java
Outdated
Show resolved
Hide resolved
client/rest-high-level/src/main/java/org/elasticsearch/client/SecurityClient.java
Outdated
Show resolved
Hide resolved
...nt/rest-high-level/src/main/java/org/elasticsearch/client/security/user/privileges/Role.java
Show resolved
Hide resolved
Contributor
Author
|
@elasticmachine run the gradle build tests 1 |
Contributor
Author
@elasticmachine run the gradle build tests 1 |
jkakavas
added a commit
that referenced
this pull request
Nov 26, 2018
This commits adds support for the Get Roles API to the HLRC Relates: #29827
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This commits adds support for the Get Roles API to the HLRC
Relates: #29827