3737import java .util .List ;
3838
3939/**
40- * Interface that specifies a set of {@code transit} operations executed on a reactive
41- * infrastructure, implemented by
42- * {@link org.springframework.vault.core.ReactiveVaultTransitTemplate}.
40+ * * Interface that specifies operations using the {@code transit} backend.
4341 *
4442 * @author James Luke
43+ * @since 3.1
44+ * @see <a href="https://www.vaultproject.io/docs/secrets/transit/index.html">Transit
45+ * Secret Backend</a>
4546 */
4647public interface ReactiveVaultTransitOperations {
4748
4849 /**
49- * Create a new named encryption key given a {@code name}
50- * @param keyName must not be empty or {@literal null}
50+ * Create a new named encryption key given a {@code name}.
51+ * @param keyName must not be empty or {@literal null}.
5152 */
5253 Mono <Void > createKey (String keyName );
5354
@@ -61,7 +62,8 @@ public interface ReactiveVaultTransitOperations {
6162 Mono <Void > createKey (String keyName , VaultTransitKeyCreationRequest createKeyRequest );
6263
6364 /**
64- * @return stream of transit key names.
65+ * Get a {@link Flux} of transit key names.
66+ * @return {@link Flux} of transit key names.
6567 */
6668 Flux <String > getKeys ();
6769
@@ -78,14 +80,14 @@ public interface ReactiveVaultTransitOperations {
7880 * operation.
7981 * @param keyName must not be empty or {@literal null}.
8082 * @param type must not be {@literal null}.
81- * @return the {@link RawTransitKey}. May be empty if key does not exist
83+ * @return the {@link RawTransitKey}. Empty if key does not exist
8284 */
8385 Mono <RawTransitKey > exportKey (String keyName , TransitKeyType type );
8486
8587 /**
8688 * Return information about a named encryption key.
8789 * @param keyName must not be empty or {@literal null}.
88- * @return the {@link VaultTransitKey}. May be empty if key does not exist
90+ * @return the {@link VaultTransitKey}. Empty if key does not exist.
8991 */
9092 Mono <VaultTransitKey > getKey (String keyName );
9193
@@ -230,10 +232,10 @@ public interface ReactiveVaultTransitOperations {
230232 * a type that supports rotation, configured {@link VaultHmacRequest#getKeyVersion()}
231233 * will be used.
232234 * @param keyName must not be empty or {@literal null}.
233- * @param hmacRequest the {@link VaultHmacRequest}, must not be {@literal null}.
235+ * @param request the {@link VaultHmacRequest}, must not be {@literal null}.
234236 * @return the digest of given data the default hash algorithm and the named key.
235237 */
236- Mono <Hmac > getHmac (String keyName , VaultHmacRequest hmacRequest );
238+ Mono <Hmac > getHmac (String keyName , VaultHmacRequest request );
237239
238240 /**
239241 * Create a cryptographic signature using {@code keyName} of the given
@@ -250,10 +252,10 @@ public interface ReactiveVaultTransitOperations {
250252 * {@link VaultSignRequest} and the specified hash algorithm. The key must be of a
251253 * type that supports signing.
252254 * @param keyName must not be empty or {@literal null}.
253- * @param signRequest {@link VaultSignRequest} must not be empty or {@literal null}.
255+ * @param request {@link VaultSignRequest} must not be empty or {@literal null}.
254256 * @return Signature for {@link VaultSignRequest}.
255257 */
256- Mono <Signature > sign (String keyName , VaultSignRequest signRequest );
258+ Mono <Signature > sign (String keyName , VaultSignRequest request );
257259
258260 /**
259261 * Verify the cryptographic signature using {@code keyName} of the given
@@ -269,10 +271,10 @@ public interface ReactiveVaultTransitOperations {
269271 * Verify the cryptographic signature using {@code keyName} of the given
270272 * {@link VaultSignRequest}.
271273 * @param keyName must not be empty or {@literal null}.
272- * @param verificationRequest {@link VaultSignatureVerificationRequest} must not be
274+ * @param request {@link VaultSignatureVerificationRequest} must not be
273275 * {@literal null}.
274276 * @return the resulting {@link SignatureValidation}.
275277 */
276- Mono <SignatureValidation > verify (String keyName , VaultSignatureVerificationRequest verificationRequest );
278+ Mono <SignatureValidation > verify (String keyName , VaultSignatureVerificationRequest request );
277279
278280}
0 commit comments