aws / aws/aws-encryption-sdk-java

JavaDocs: Document replacement methods for MKP methods

Ouverte
#2,040 1 commentaire 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
Java
Étoiles
240
Forks
125
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

### 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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Trouvez les JavaDocs des méthodes obsolètes de MasterKeyProvider et des méthodes de Caching Cryptographic Materials Manager. Lisez ensuite les issues associées 2035 et 2033, puis comparez les APIs obsolètes aux méthodes de Keyring auxquelles elles font référence. Le travail est terminé lorsque le remplacement de chaque méthode obsolète est documenté et que la question concernant Caching CMM est résolue ou clairement documentée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
documentation
Type d'issue
Documentation
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.