Package com.oracle.bmc.certificates

Interface CertificatesAsync

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

    • 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 serice.

      • 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

        Future<GetCaBundleResponse> getCaBundle​(GetCaBundleRequest request,
                                        AsyncHandler<GetCaBundleRequest,​GetCaBundleResponse> handler)
        Gets a ca-bundle bundle.
        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.

      • getCertificateAuthorityBundle

        Future<GetCertificateAuthorityBundleResponse> getCertificateAuthorityBundle​(GetCertificateAuthorityBundleRequest request,
                                                                            AsyncHandler<GetCertificateAuthorityBundleRequest,​GetCertificateAuthorityBundleResponse> handler)
        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
        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.

      • getCertificateBundle

        Future<GetCertificateBundleResponse> getCertificateBundle​(GetCertificateBundleRequest request,
                                                          AsyncHandler<GetCertificateBundleRequest,​GetCertificateBundleResponse> handler)
        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
        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.