aws / aws/aws-encryption-sdk-java

JavaDocs: Document replacement methods for MKP methods

オープン
#2,040 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る
主要言語
Java
スター
240
フォーク
125
PR マージ指標
30日以内にマージされた PR はありません

説明

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

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

非推奨の MasterKeyProvider メソッドと Caching Cryptographic Materials Manager メソッドの JavaDocs を見つけてください。関連する issue 2035 と 2033 を読み、その後、非推奨の API と、それらが参照している Keyring メソッドを比較してください。各非推奨メソッドの置き換えが文書化され、Caching CMM に関する疑問が解決または明確に文書化されていれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。