HDDS-2661. Use field based Config annotation instead of method based #297
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.
What changes were proposed in this pull request?
HDDS-2413 proposes an additional usage of the @config annotation: to set configuration based on an existing configuration class.
But as of now we annotate the setters instead of the fields. To avoid annotation duplication (we need to read the values from the getters or the fields) I propose to switch to use field based annotations instead of setter based annotation.
I think it's more readable and additional validation (even the class level validations) can be done in a @PostConstruct method.
How is it implemented
To support the annotation in private field we need to update our logic to check the fields of the parent class(es). It was not necessary with the setter based approach as the setter methods are public inherited. The patch updates both the annoation processor and the reflection based API (OzoneConfiguration).
With field based annotation injection it's not possible to put validation logic to the setters, therefor the standard
@PostConstructannotation is used to provide class level validation (or any other execution).What is the link to the Apache JIRA
https://issues.apache.org/jira/browse/HDDS-2661
How was this patch tested?
Mainly with unit tests. New unit test is introduced in configuration project and the TestOzoneConfiguration is also improved.