gnodet-bot commented on code in PR #28105:
URL: https://github.com/apache/camel/pull/28105#discussion_r4312846080
##########
components/camel-pqc/src/main/java/org/apache/camel/component/pqc/lifecycle/AzureKeyVaultKeyLifecycleManager.java:
##########
@@ -294,12 +294,16 @@ public KeyMetadata getKeyMetadata(String keyId) throws
Exception {
}
@Override
+ /**
+ * Writes the metadata secret only.
+ * <p/>
+ * Re-storing the key pair here would create a new version of the private
key secret on every status change, and
+ * would make revoking a key whose private secret is already gone
impossible - which is exactly when revoking
+ * matters.
+ */
Review Comment:
💡 **Style nit:** The Javadoc block is placed after `@Override`, so the
javadoc tool doesn't associate it with the method — it falls back to the
inherited interface documentation instead. Move the `/** ... */` block above
`@Override`:
```suggestion
/**
* Writes the metadata secret only.
* <p/>
* Re-storing the key pair here would create a new version of the
private key secret on every status change, and
* would make revoking a key whose private secret is already gone
impossible - which is exactly when revoking
* matters.
*/
@Override
```
##########
components/camel-pqc/src/main/java/org/apache/camel/component/pqc/lifecycle/AwsSecretsManagerKeyLifecycleManager.java:
##########
@@ -367,12 +367,17 @@ public KeyMetadata getKeyMetadata(String keyId) throws
Exception {
}
@Override
+ /**
+ * Writes the metadata secret only.
+ * <p/>
+ * Re-storing the key pair here would create a new version of the private
key secret on every status change, and
+ * would make revoking a key whose private secret is already gone
impossible - which is exactly when revoking
+ * matters.
+ */
Review Comment:
💡 **Style nit:** The Javadoc block is placed after `@Override`, so the
javadoc tool doesn't associate it with the method — it falls back to the
inherited interface documentation instead. Move the `/** ... */` block above
`@Override`:
```suggestion
/**
* Writes the metadata secret only.
* <p/>
* Re-storing the key pair here would create a new version of the
private key secret on every status change, and
* would make revoking a key whose private secret is already gone
impossible - which is exactly when revoking
* matters.
*/
@Override
```
##########
components/camel-pqc/src/main/java/org/apache/camel/component/pqc/lifecycle/HashicorpVaultKeyLifecycleManager.java:
##########
@@ -407,12 +407,25 @@ public KeyMetadata getKeyMetadata(String keyId) throws
Exception {
}
@Override
+ /**
+ * Writes the metadata entry only.
+ * <p/>
+ * Re-storing the key pair here would create a new version of the private
key entry on every status change - with
+ * the default {@code max_versions = 10} of a KV v2 mount, ten metadata
edits purge every historical version of the
+ * private key. It would also make revoking a key whose private entry is
already gone impossible, which is exactly
+ * when revoking matters.
+ */
Review Comment:
💡 **Style nit:** The Javadoc block is placed after `@Override`, so the
javadoc tool doesn't associate it with the method — it falls back to the
inherited interface documentation instead. Move the `/** ... */` block above
`@Override`:
```suggestion
/**
* Writes the metadata entry only.
* <p/>
* Re-storing the key pair here would create a new version of the
private key entry on every status change - with
* the default {@code max_versions = 10} of a KV v2 mount, ten metadata
edits purge every historical version of the
* private key. It would also make revoking a key whose private entry is
already gone impossible, which is exactly
* when revoking matters.
*/
@Override
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
