Package com.oracle.bmc.certificates

Interface Certificates

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    CertificatesClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210224")
public interface Certificates
extends AutoCloseable
    API for retrieving certificates.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • getCaBundle

        GetCaBundleResponse getCaBundle​(GetCaBundleRequest request)
        Gets a ca-bundle bundle.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/certificates/GetCaBundleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCaBundle API.

      • getCertificateAuthorityBundle

        GetCertificateAuthorityBundleResponse getCertificateAuthorityBundle​(GetCertificateAuthorityBundleRequest request)
        Gets a certificate authority bundle that matches either the specified stage, name, or versionNumber parameter.

        If none of these parameters are provided, the bundle for the certificate authority version marked as CURRENT will be returned.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/certificates/GetCertificateAuthorityBundleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCertificateAuthorityBundle API.

      • getCertificateBundle

        GetCertificateBundleResponse getCertificateBundle​(GetCertificateBundleRequest request)
        Gets a certificate bundle that matches either the specified stage, versionName, or versionNumber parameter.

        If none of these parameters are provided, the bundle for the certificate version marked as CURRENT will be returned.

        By default, the private key is not included in the query result, and a CertificateBundlePublicOnly is returned. If the private key is needed, use the CertificateBundleTypeQueryParam parameter to get a CertificateBundleWithPrivateKey response.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/certificates/GetCertificateBundleExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCertificateBundle API.

      • listCertificateAuthorityBundleVersions

        ListCertificateAuthorityBundleVersionsResponse listCertificateAuthorityBundleVersions​(ListCertificateAuthorityBundleVersionsRequest request)
        Lists all certificate authority bundle versions for the specified certificate authority.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/certificates/ListCertificateAuthorityBundleVersionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCertificateAuthorityBundleVersions API.

      • listCertificateBundleVersions

        ListCertificateBundleVersionsResponse listCertificateBundleVersions​(ListCertificateBundleVersionsRequest request)
        Lists all certificate bundle versions for the specified certificate.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/certificates/ListCertificateBundleVersionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCertificateBundleVersions API.