aws / aws/aws-encryption-sdk-java
JavaDocs: Document replacement methods for MKP methods
- Lenguaje dominante
- Java
- Estrellas
- 240
- Forks
- 125
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### 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
Guía de contribución
Línea de trabajo
Localiza los JavaDocs de los métodos obsoletos de MasterKeyProvider y de los métodos de Caching Cryptographic Materials Manager. Lee las issues relacionadas 2035 y 2033 y, después, compara las APIs obsoletas con los métodos de Keyring a los que hacen referencia. Se considera terminado cuando se haya documentado el reemplazo de cada método obsoleto y la cuestión de Caching CMM se haya resuelto o documentado claramente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100