Package com.oracle.bmc.keymanagement

Class KmsCryptoClient

    • 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

      • KmsCryptoClient

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

      • KmsCryptoClient

        @Deprecated
public KmsCryptoClient​(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

      • KmsCryptoClient

        @Deprecated
public KmsCryptoClient​(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

      • KmsCryptoClient

        @Deprecated
public KmsCryptoClient​(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

      • KmsCryptoClient

        @Deprecated
public KmsCryptoClient​(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 DecryptResponse decrypt​(DecryptRequest request)
        Description copied from interface: KmsCrypto
        Decrypts data using the given DecryptDataDetails resource.
        Specified by:
        decrypt in interface KmsCrypto
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • encrypt

        public EncryptResponse encrypt​(EncryptRequest request)
        Description copied from interface: KmsCrypto
        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 KmsCrypto
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • exportKey

        public ExportKeyResponse exportKey​(ExportKeyRequest request)
        Description copied from interface: KmsCrypto
        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 KmsCrypto
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • sign

        public SignResponse sign​(SignRequest request)
        Description copied from interface: KmsCrypto
        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 KmsCrypto
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • verify

        public VerifyResponse verify​(VerifyRequest request)
        Description copied from interface: KmsCrypto
        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 KmsCrypto
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation

      • enableDualStackEndpoints

        public void enableDualStackEndpoints​(boolean enableDualStackEndpoints)
        This method should be used to enable or disable the use of dual-stack endpoints.

        The default value is false i.e. dual-stack endpoints are disabled by default.

        Parameters:
        enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

      • getOptionsMap

        public Map<String,​Boolean> getOptionsMap()
        Return an immutable snapshot representing the current options set for this client.
        Returns:
        immutable snapshot representing the current options set for this client

      • getResolvedEndpoint

        public String getResolvedEndpoint​(Map<String,​Object> requiredParametersMap)
        Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
        Parameters:
        requiredParametersMap - the map from required parameter name to their values
        Returns:
        resolved endpoint, with all options and placeholders filled in

      • 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

      • setEndpoint

        public final void setEndpoint​(String endpoint)

      • getEndpoint

        public final String getEndpoint()
        Get the endpoint of the client.

        Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

        Examples of endpoints this may return:

        • Unparameterized endpoints 
                       https://identity.us-phoenix-1.oci.oraclecloud.com
             https://identity.us-ashburn-1.oci.oraclecloud.com
             https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with placeholders 
                       https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
        • Parameterized endpoints with options 
                       https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
             https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
        • Parameterized endpoints with placeholders and options 
                       https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
             https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com

        To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

        Returns:
        the endpoint being used by the client

      • 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()