@Generated(value="OracleSDKGenerator", comments="API Version: release") public class KmsCryptoAsyncClient extends Object implements KmsCryptoAsync
Async client implementation for KmsCrypto service.
There are two ways to use async client:
InputStream, like
getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else,
because the stream will be closed right after the AsyncHandler is invoked. | Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for KmsCrypto.
|
| Constructor and Description |
|---|
KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsCryptoAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
KmsCryptoAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
KmsCryptoAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
| Modifier and Type | Method and Description |
|---|---|
static KmsCryptoAsyncClientBuilder |
builder()
Create a builder for this client.
|
void |
close() |
Future<DecryptResponse> |
decrypt(DecryptRequest request,
AsyncHandler<DecryptRequest,DecryptResponse> handler)
Decrypts data using the given DecryptDataDetails resource.
|
Future<EncryptResponse> |
encrypt(EncryptRequest request,
AsyncHandler<EncryptRequest,EncryptResponse> handler)
Encrypts data using the given EncryptDataDetails resource.
|
Future<ExportKeyResponse> |
exportKey(ExportKeyRequest request,
AsyncHandler<ExportKeyRequest,ExportKeyResponse> handler)
Exports a specific version of a master encryption key according to the details of the request.
|
Future<GenerateDataEncryptionKeyResponse> |
generateDataEncryptionKey(GenerateDataEncryptionKeyRequest request,
AsyncHandler<GenerateDataEncryptionKeyRequest,GenerateDataEncryptionKeyResponse> handler)
Generates a key that you can use to encrypt or decrypt data.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
Future<SignResponse> |
sign(SignRequest request,
AsyncHandler<SignRequest,SignResponse> handler)
Creates a digital signature for a message or message digest by using the private key of a public-private key pair,
also known as an asymmetric key.
|
Future<VerifyResponse> |
verify(VerifyRequest request,
AsyncHandler<VerifyRequest,VerifyResponse> handler)
Verifies a digital signature that was generated by the Sign operation
by using the public key of the same asymmetric key that was used to sign the data.
|
public static final Service SERVICE
Service instance for KmsCrypto.
public KmsCryptoAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public KmsCryptoAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public KmsCryptoAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public KmsCryptoAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static KmsCryptoAsyncClientBuilder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
KmsCryptoAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface KmsCryptoAsyncendpoint - The endpoint of the serice.public String getEndpoint()
KmsCryptoAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface KmsCryptoAsyncpublic void close()
close in interface AutoCloseablepublic Future<DecryptResponse> decrypt(DecryptRequest request, AsyncHandler<DecryptRequest,DecryptResponse> handler)
KmsCryptoAsyncDecrypts data using the given DecryptDataDetails resource.
decrypt in interface KmsCryptoAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<EncryptResponse> encrypt(EncryptRequest request, AsyncHandler<EncryptRequest,EncryptResponse> handler)
KmsCryptoAsyncEncrypts data using the given EncryptDataDetails resource. Plaintext included in the example request is a base64-encoded value of a UTF-8 string.
encrypt in interface KmsCryptoAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ExportKeyResponse> exportKey(ExportKeyRequest request, AsyncHandler<ExportKeyRequest,ExportKeyResponse> handler)
KmsCryptoAsyncExports a specific version of a master encryption key according to the details of the request. For their protection, keys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys stored on the server. For export, the key version is encrypted by an RSA public key that you provide.
exportKey in interface KmsCryptoAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GenerateDataEncryptionKeyResponse> generateDataEncryptionKey(GenerateDataEncryptionKeyRequest request, AsyncHandler<GenerateDataEncryptionKeyRequest,GenerateDataEncryptionKeyResponse> handler)
KmsCryptoAsyncGenerates a key that you can use to encrypt or decrypt data.
generateDataEncryptionKey in interface KmsCryptoAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<SignResponse> sign(SignRequest request, AsyncHandler<SignRequest,SignResponse> handler)
KmsCryptoAsyncCreates a digital signature for a message or message digest by using the private key of a public-private key pair, also known as an asymmetric key. To verify the generated signature, you can use the Verify operation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key.
sign in interface KmsCryptoAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<VerifyResponse> verify(VerifyRequest request, AsyncHandler<VerifyRequest,VerifyResponse> handler)
KmsCryptoAsyncVerifies a digital signature that was generated by the Sign operation by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the digital signature outside of the service, you can do so by using the public key of the asymmetric key.
verify in interface KmsCryptoAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.