Adding convenience methods the create builders internally

Author: WesleyRosenblum

src/examples/java/com/amazonaws/crypto/examples/EscrowedEncryptExample.java

@@ -89,7 +89,7 @@ private static byte[] standardEncrypt(final AwsKmsCmkId kmsArn, final PublicKey
 
         // 3. Instantiate a RawRsaKeyring
         //    Because the user does not have access to the private escrow key,
-        //    they pass in "null" for the private key parameter.
+        //    they do not provide the private key parameter.
         final Keyring rsaKeyring = StandardKeyrings.rawRsa()
                 .keyNamespace("Escrow")
                 .keyName("Escrow")

src/examples/java/com/amazonaws/crypto/examples/FileStreamingExample.java

@@ -99,7 +99,7 @@ static void encryptAndDecrypt(final File srcFile, final File encryptedFile, fina
         }
 
         // 7. Create the decrypting input stream with the keyring.
-        try(final AwsCryptoInputStream decryptingStream = crypto.createDecryptingInputStream(
+        try (final AwsCryptoInputStream decryptingStream = crypto.createDecryptingInputStream(
                 CreateDecryptingInputStreamRequest.builder()
                         .keyring(keyring)
                         .inputStream(new FileInputStream(encryptedFile)).build())) {
@@ -143,7 +143,6 @@ private static void compareFiles(File file1, File file2) throws IOException {
                     (file2Line = file2Reader.readLine()) != null) {
                 assert Objects.equals(file1Line, file2Line);
             }
-
         }
     }
 

src/main/java/com/amazonaws/encryptionsdk/AwsCrypto.java

@@ -18,6 +18,7 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Collections;
 import java.util.Map;
+import java.util.function.Consumer;
 
 import com.amazonaws.encryptionsdk.exception.AwsCryptoException;
 import com.amazonaws.encryptionsdk.exception.BadCiphertextException;
@@ -255,6 +256,21 @@ public long estimateCiphertextSize(final EstimateCiphertextSizeRequest request)
         return cryptoHandler.estimateOutputSize(request.plaintextSize());
     }
 
+    /**
+     * Returns the best estimate for the output length of encrypting a plaintext with the plaintext size specified in
+     * the provided {@link EstimateCiphertextSizeRequest}. The actual ciphertext may be shorter.
+     * <p>
+     * This is a convenience which creates an instance of the {@link EstimateCiphertextSizeRequest.Builder} avoiding the need to
+     * create one manually via {@link EstimateCiphertextSizeRequest#builder()}
+     * </p>
+     *
+     * @param request A Consumer that will call methods on EstimateCiphertextSizeRequest.Builder to create a request.
+     * @return The estimated output length in bytes
+     */
+    public long estimateCiphertextSize(final Consumer<EstimateCiphertextSizeRequest.Builder> request) {
+        return estimateCiphertextSize(EstimateCiphertextSizeRequest.builder().applyMutation(request).build());
+    }
+
     /**
      * Returns an encrypted form of {@code plaintext} that has been protected with {@link DataKey}s
      * that are in turn protected by {@link MasterKey MasterKeys} provided by
@@ -355,6 +371,21 @@ public AwsCryptoResult<byte[]> encrypt(final EncryptRequest request) {
                 cryptoHandler.getMasterKeys(), cryptoHandler.getHeaders());
     }
 
+    /**
+     * Returns an encrypted form of {@code plaintext} that has been protected with either the {@link CryptoMaterialsManager}
+     * or the {@link Keyring} specified in the {@link EncryptRequest}.
+     * <p>
+     * This is a convenience which creates an instance of the {@link EncryptRequest.Builder} avoiding the need to
+     * create one manually via {@link EncryptRequest#builder()}
+     * </p>
+     *
+     * @param request A Consumer that will call methods on EncryptRequest.Builder to create a request.
+     * @return An {@link AwsCryptoResult} containing the encrypted data
+     */
+    public AwsCryptoResult<byte[]> encrypt(final Consumer<EncryptRequest.Builder> request) {
+        return encrypt(EncryptRequest.builder().applyMutation(request).build());
+    }
+
     /**
      * Calls {@link #encryptData(MasterKeyProvider, byte[], Map)} on the UTF-8 encoded bytes of
      * {@code plaintext} and base64 encodes the result.
@@ -525,6 +556,21 @@ public AwsCryptoResult<byte[]> decrypt(final DecryptRequest request) {
                 cryptoHandler.getMasterKeys(), cryptoHandler.getHeaders());
     }
 
+    /**
+     * Decrypts the provided {@link ParsedCiphertext} using the {@link CryptoMaterialsManager} or the {@link Keyring}
+     * specified in the {@link DecryptRequest}.
+     * <p>
+     * This is a convenience which creates an instance of the {@link DecryptRequest.Builder} avoiding the need to
+     * create one manually via {@link DecryptRequest#builder()}
+     * </p>
+     *
+     * @param request A Consumer that will call methods on DecryptRequest.Builder to create a request.
+     * @return An {@link AwsCryptoResult} containing the decrypted data
+     */
+    public AwsCryptoResult<byte[]> decrypt(final Consumer<DecryptRequest.Builder> request) {
+        return decrypt(DecryptRequest.builder().applyMutation(request).build());
+    }
+
     /**
      * Base64 decodes the {@code ciphertext} prior to decryption and then treats the results as a
      * UTF-8 encoded string.
@@ -658,6 +704,21 @@ public AwsCryptoOutputStream createEncryptingOutputStream(final CreateEncrypting
                 request.cryptoMaterialsManager(), request.encryptionContext()));
     }
 
+    /**
+     * Returns a {@link AwsCryptoOutputStream} which encrypts the data prior to passing it onto the
+     * underlying {@link OutputStream}.
+     * <p>
+     * This is a convenience which creates an instance of the {@link CreateEncryptingOutputStreamRequest.Builder} avoiding the need to
+     * create one manually via {@link CreateEncryptingOutputStreamRequest#builder()}
+     * </p>
+     *
+     * @see #encrypt(EncryptRequest)
+     * @see javax.crypto.CipherOutputStream
+     */
+    public AwsCryptoOutputStream createEncryptingOutputStream(final Consumer<CreateEncryptingOutputStreamRequest.Builder> request) {
+        return createEncryptingOutputStream(CreateEncryptingOutputStreamRequest.builder().applyMutation(request).build());
+    }
+
     /**
      * Returns a {@link CryptoInputStream} which encrypts the data after reading it from the
      * underlying {@link InputStream}.
@@ -748,6 +809,21 @@ public AwsCryptoInputStream createEncryptingInputStream(final CreateEncryptingIn
         return new AwsCryptoInputStream(request.inputStream(), cryptoHandler);
     }
 
+    /**
+     * Returns a {@link AwsCryptoInputStream} which encrypts the data after reading it from the
+     * underlying {@link InputStream}.
+     * <p>
+     * This is a convenience which creates an instance of the {@link CreateEncryptingInputStreamRequest.Builder} avoiding the need to
+     * create one manually via {@link CreateEncryptingInputStreamRequest#builder()}
+     * </p>
+     *
+     * @see #encrypt(EncryptRequest)
+     * @see javax.crypto.CipherInputStream
+     */
+    public AwsCryptoInputStream createEncryptingInputStream(final Consumer<CreateEncryptingInputStreamRequest.Builder> request) {
+        return createEncryptingInputStream(CreateEncryptingInputStreamRequest.builder().applyMutation(request).build());
+    }
+
     /**
      * Returns a {@link CryptoOutputStream} which decrypts the data prior to passing it onto the
      * underlying {@link OutputStream}.
@@ -812,6 +888,22 @@ public AwsCryptoOutputStream createDecryptingOutputStream(final CreateDecrypting
         return new AwsCryptoOutputStream(request.outputStream(), cryptoHandler);
     }
 
+
+    /**
+     * Returns a {@link AwsCryptoOutputStream} which decrypts the data prior to passing it onto the
+     * underlying {@link OutputStream}.
+     * <p>
+     * This is a convenience which creates an instance of the {@link CreateDecryptingOutputStreamRequest.Builder} avoiding the need to
+     * create one manually via {@link CreateDecryptingOutputStreamRequest#builder()}
+     * </p>
+     *
+     * @see #decrypt(DecryptRequest)
+     * @see javax.crypto.CipherOutputStream
+     */
+    public AwsCryptoOutputStream createDecryptingOutputStream(final Consumer<CreateDecryptingOutputStreamRequest.Builder> request) {
+        return createDecryptingOutputStream(CreateDecryptingOutputStreamRequest.builder().applyMutation(request).build());
+    }
+
     /**
      * Returns a {@link CryptoInputStream} which decrypts the data after reading it from the
      * underlying {@link InputStream}.
@@ -844,6 +936,21 @@ public AwsCryptoInputStream createDecryptingInputStream(final CreateDecryptingIn
         return new AwsCryptoInputStream(request.inputStream(), cryptoHandler);
     }
 
+    /**
+     * Returns a {@link AwsCryptoInputStream} which decrypts the data after reading it from the
+     * underlying {@link InputStream}.
+     * <p>
+     * This is a convenience which creates an instance of the {@link CreateDecryptingInputStreamRequest.Builder} avoiding the need to
+     * create one manually via {@link CreateDecryptingInputStreamRequest#builder()}
+     * </p>
+     *
+     * @see #encrypt(EncryptRequest)
+     * @see javax.crypto.CipherInputStream
+     */
+    public AwsCryptoInputStream createDecryptingInputStream(final Consumer<CreateDecryptingInputStreamRequest.Builder> request) {
+        return createDecryptingInputStream(CreateDecryptingInputStreamRequest.builder().applyMutation(request).build());
+    }
+
     private MessageCryptoHandler getEncryptingStreamHandler(
             CryptoMaterialsManager materialsManager, Map<String, String> encryptionContext
     ) {

src/main/java/com/amazonaws/encryptionsdk/AwsCryptoRequest.java

@@ -11,7 +11,11 @@
  * specific language governing permissions and limitations under the License.
  */
 
-package com.amazonaws.encryptionsdk;import com.amazonaws.encryptionsdk.keyrings.Keyring;
+package com.amazonaws.encryptionsdk;
+
+import com.amazonaws.encryptionsdk.keyrings.Keyring;
+
+import java.util.function.Consumer;
 
 import static java.util.Objects.requireNonNull;
 import static org.apache.commons.lang3.Validate.isTrue;
@@ -65,5 +69,10 @@ public T keyring(Keyring keyring) {
         }
 
         abstract T getThis();
+
+        T applyMutation(Consumer<T> mutator) {
+            mutator.accept(getThis());
+            return getThis();
+        }
     }
 }

src/test/java/com/amazonaws/encryptionsdk/AwsCryptoTest.java

@@ -101,13 +101,13 @@ private void doEncryptDecryptWithKeyring(final CryptoAlgorithm cryptoAlg, final
         encryptionClient_.setEncryptionAlgorithm(cryptoAlg);
         encryptionClient_.setEncryptionFrameSize(frameSize);
 
-        final byte[] cipherText = encryptionClient_.encrypt(EncryptRequest.builder()
+        final byte[] cipherText = encryptionClient_.encrypt(request -> request
                 .keyring(keyring)
                 .encryptionContext(encryptionContext)
-                .plaintext(plaintextBytes).build()).getResult();
-        final byte[] decryptedText = encryptionClient_.decrypt(DecryptRequest.builder()
+                .plaintext(plaintextBytes)).getResult();
+        final byte[] decryptedText = encryptionClient_.decrypt(request -> request
                 .keyring(keyring)
-                .ciphertext(cipherText).build()).getResult();
+                .ciphertext(cipherText)).getResult();
 
         assertArrayEquals("Bad encrypt/decrypt for " + cryptoAlg, plaintextBytes, decryptedText);
     }
@@ -657,7 +657,6 @@ public void assertNullValidation() throws Exception {
                 .cryptoMaterialsManager(cmm)
                 .plaintextSize(42).build()
         );
-
         assertNullChecks(encryptionClient_, "encryptData",
                                    MasterKeyProvider.class, provider,
                                    byte[].class, buf,