Interface AsyncKeyEncapsulationService

All Superinterfaces:

BaseKeyEncapsulationService

All Known Implementing Classes:

DelegatingAsyncKeyEncapsulationService, LocalKeyEncapsulationService

@Preview(name="Property Encryption")
public non-sealed interface AsyncKeyEncapsulationService
extends BaseKeyEncapsulationService

A service responsible for encapsulating and decapsulating keys.

Implementations MUST be non-blocking. In particular, implementations MUST NOT perform blocking operations on the calling thread.

Implementations MUST supply 256-bit AES keys only.

Since:

6.3.0

See Also:

• KeyEncapsulationOptions
• KeyEncapsulationResult
• KeyEncapsulationServices

Method Summary

Modifier and Type	Method	Description
CompletionStage<SecretKey>	decapsulateAsync(byte[] encapsulation, Map<String,String> metadata)	Decapsulates encapsulated bytes.
CompletionStage<KeyEncapsulationResult>	encapsulateAsync(KeyEncapsulationOptions options)	Creates a new key, encapsulates it and returns the result.

Method Details

encapsulateAsync

CompletionStage<KeyEncapsulationResult> encapsulateAsync(KeyEncapsulationOptions options)

Creates a new key, encapsulates it and returns the result.

Parameters:

options - the encapsulation options

Returns:

a CompletionStage that completes with the encapsulation result

decapsulateAsync

CompletionStage<SecretKey> decapsulateAsync(byte[] encapsulation,
 Map<String,String> metadata)

Decapsulates encapsulated bytes.

Parameters:

encapsulation - the encapsulated bytes, must not be null

metadata - the key metadata, must not be null

Returns:

a CompletionStage that completes with the decapsulated key