Package com.oracle.bmc.keymanagement

Class KmsCryptoAsyncClient

  • All Implemented Interfaces:
    KmsCryptoAsync, AutoCloseable
    @Generated(value="OracleSDKGenerator",
           comments="API Version: release")
public class KmsCryptoAsyncClient
extends BaseAsyncClient
implements KmsCryptoAsync
    Async client implementation for KmsCrypto service.
    There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an 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.
    2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
    Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
    Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

    • Field Detail

      • SERVICE

        public static final Service SERVICE
        Service instance for KmsCrypto.

      • clientCommonLibraryVersion

        public final String clientCommonLibraryVersion
        Compatible SDK version, provided by the codegen.

      • minimumClientCommonLibraryVersionFromClient

        public final Optional<String> minimumClientCommonLibraryVersionFromClient
        Minimum compatible SDK version, maybe provided by the codegen.

    • Constructor Detail

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory
        additionalClientConfigurators - Builder#additionalClientConfigurators

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory
        additionalClientConfigurators - Builder#additionalClientConfigurators
        endpoint - Builder#endpoint

      • KmsCryptoAsyncClient

        @Deprecated
public KmsCryptoAsyncClient​(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration,
                            ClientConfigurator clientConfigurator,
                            RequestSignerFactory defaultRequestSignerFactory,
                            Map<SigningStrategy,​RequestSignerFactory> signingStrategyRequestSignerFactories,
                            List<ClientConfigurator> additionalClientConfigurators,
                            String endpoint)
        Deprecated.
        Use the builder instead.
        Create a new client instance.
        Parameters:
        authenticationDetailsProvider - The authentication details (see Builder#build)
        configuration - Builder#configuration
        clientConfigurator - Builder#clientConfigurator
        defaultRequestSignerFactory - Builder#requestSignerFactory
        additionalClientConfigurators - Builder#additionalClientConfigurators
        endpoint - Builder#endpoint
        signingStrategyRequestSignerFactories - Builder#signingStrategyRequestSignerFactories

    • Method Detail

      • decrypt

        public Future<DecryptResponse> decrypt​(DecryptRequest request,
                                       AsyncHandler<DecryptRequest,​DecryptResponse> handler)
        Description copied from interface: KmsCryptoAsync
        Decrypts data using the given DecryptDataDetails resource.
        Specified by:
        decrypt in interface KmsCryptoAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • encrypt

        public Future<EncryptResponse> encrypt​(EncryptRequest request,
                                       AsyncHandler<EncryptRequest,​EncryptResponse> handler)
        Description copied from interface: KmsCryptoAsync
        Encrypts data using the given EncryptDataDetails resource.

        Plaintext included in the example request is a base64-encoded value of a UTF-8 string.

        Specified by:
        encrypt in interface KmsCryptoAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • exportKey

        public Future<ExportKeyResponse> exportKey​(ExportKeyRequest request,
                                           AsyncHandler<ExportKeyRequest,​ExportKeyResponse> handler)
        Description copied from interface: KmsCryptoAsync
        Exports 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. This operation is not supported for keys having protection mode EXTERNAL.

        Specified by:
        exportKey in interface KmsCryptoAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • sign

        public Future<SignResponse> sign​(SignRequest request,
                                 AsyncHandler<SignRequest,​SignResponse> handler)
        Description copied from interface: KmsCryptoAsync
        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.

        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. This operation is not supported for keys having protection mode EXTERNAL.

        Specified by:
        sign in interface KmsCryptoAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • verify

        public Future<VerifyResponse> verify​(VerifyRequest request,
                                     AsyncHandler<VerifyRequest,​VerifyResponse> handler)
        Description copied from interface: KmsCryptoAsync
        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.

        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. This operation is not supported for keys having protection mode EXTERNAL.

        Specified by:
        verify in interface KmsCryptoAsync
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • useRealmSpecificEndpointTemplate

        public void useRealmSpecificEndpointTemplate​(boolean useOfRealmSpecificEndpointTemplateEnabled)
        This method should be used to enable or disable the use of realm-specific endpoint template.

        The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

        Parameters:
        useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

      • populateServiceParametersInEndpoint

        public final void populateServiceParametersInEndpoint​(String endpoint,
                                                      Map<String,​Object> requiredParametersMap)
        Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

        The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

        Parameters:
        endpoint - The endpoint template in use
        requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

      • updateBaseEndpoint

        public final void updateBaseEndpoint​(String endpoint)
        This method should be used for parameterized endpoint templates only.

        This does not include {region} and {secondLevelDomain} parameters.

        Parameters:
        endpoint - The updated endpoint to use

      • setEndpoint

        public final void setEndpoint​(String endpoint)

      • getEndpoint

        public final String getEndpoint()

      • refreshClient

        public final void refreshClient()
        Rebuild the backing HttpClient.

        This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

      • setRegion

        protected void setRegion​(Region region)

      • setRegion

        protected void setRegion​(String regionId)

      • getClientCommonLibraryVersion

        public String getClientCommonLibraryVersion()

      • getMinimumClientCommonLibraryVersionFromClient

        public Optional<String> getMinimumClientCommonLibraryVersionFromClient()