aws / aws/aws-encryption-sdk-java
JavaDocs: Document replacement methods for MKP methods
- Lingua principale
- Java
- Stelle
- 240
- Fork
- 125
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
### Issue
Crypto Tools marked all MasterKeyProvider methods as deprecated, but did not revise their JavaDocs to state which methods should be used instead.
This is a source of customer confusion, as it is not clear that customers should use the Keyring methods instead.
_As originally posted by @jumarko in https://github.com/aws/aws-encryption-sdk-java/pull/1864#discussion_r1665561054_
Are these deprecations documented anywhere?
The javadoc doesn't say anything about what should be used instead.
### Suggested Fix
Revise the Java Docs for the Master Key Providers so that they details which methods replace the marked as deprecated methods.
Either remove the deprecation notice from the Caching Cryptographic Materials Manager methods or [implement support for the CachingCMM with Keyrings](https://github.com/aws/aws-cryptographic-material-providers-library/issues/480).
#### Related Issues
- https://github.com/aws/aws-encryption-sdk-java/issues/2035
- https://github.com/aws/aws-encryption-sdk-java/issues/2033
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Individua i JavaDocs per i metodi deprecati di MasterKeyProvider e per i metodi di Caching Cryptographic Materials Manager. Leggi i problemi correlati 2035 e 2033, quindi confronta le API deprecate con i metodi di Keyring a cui fanno riferimento. Il lavoro è completato quando è documentata la sostituzione di ogni metodo deprecato e la questione relativa a Caching CMM è stata risolta o documentata chiaramente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 42/100