Package com.oracle.bmc.certificates

Class CertificatesClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.certificates.CertificatesClient

All Implemented Interfaces:

Certificates, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210224")
public class CertificatesClient
extends BaseSyncClient
implements Certificates

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CertificatesClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for Certificates.

Constructor Summary

Constructors

Constructor	Description
CertificatesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
CertificatesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
CertificatesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
CertificatesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
CertificatesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
CertificatesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
CertificatesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static CertificatesClient.Builder	builder()	Create a builder for this client.
void	close()
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
GetCaBundleResponse	getCaBundle(GetCaBundleRequest request)	Gets a ca-bundle bundle.
GetCertificateAuthorityBundleResponse	getCertificateAuthorityBundle(GetCertificateAuthorityBundleRequest request)	Gets a certificate authority bundle that matches either the specified stage, name, or versionNumber parameter.
GetCertificateBundleResponse	getCertificateBundle(GetCertificateBundleRequest request)	Gets a certificate bundle that matches either the specified stage, versionName, or versionNumber parameter.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()	Get the endpoint of the client.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Map<String,Boolean>	getOptionsMap()	Return an immutable snapshot representing the current options set for this client.
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.
ListCertificateAuthorityBundleVersionsResponse	listCertificateAuthorityBundleVersions(ListCertificateAuthorityBundleVersionsRequest request)	Lists all certificate authority bundle versions for the specified certificate authority.
ListCertificateBundleVersionsResponse	listCertificateBundleVersions(ListCertificateBundleVersionsRequest request)	Lists all certificate bundle versions for the specified certificate.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region)	Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId)	Sets the region to call (ex, ‘us-phoenix-1’).
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.certificates.Certificates

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Certificates.

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

CertificatesClient

@Deprecated
public CertificatesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

CertificatesClient

@Deprecated
public CertificatesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

CertificatesClient

@Deprecated
public CertificatesClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

CertificatesClient

@Deprecated
public CertificatesClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

CertificatesClient

@Deprecated
public CertificatesClient(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 CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

CertificatesClient

@Deprecated
public CertificatesClient(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 CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

CertificatesClient

@Deprecated
public CertificatesClient(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 CertificatesClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static CertificatesClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Certificates

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.

Specified by:

setRegion in interface Certificates

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Certificates

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.

Specified by:

setRegion in interface Certificates

Parameters:

regionId - The public region ID.

getCaBundle

public GetCaBundleResponse getCaBundle(GetCaBundleRequest request)

Description copied from interface: Certificates

Gets a ca-bundle bundle.

Specified by:

getCaBundle in interface Certificates

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificateAuthorityBundle

public GetCertificateAuthorityBundleResponse getCertificateAuthorityBundle(GetCertificateAuthorityBundleRequest request)

Description copied from interface: Certificates

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.

Specified by:

getCertificateAuthorityBundle in interface Certificates

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getCertificateBundle

public GetCertificateBundleResponse getCertificateBundle(GetCertificateBundleRequest request)

Description copied from interface: Certificates

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.

Specified by:

getCertificateBundle in interface Certificates

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificateAuthorityBundleVersions

public ListCertificateAuthorityBundleVersionsResponse listCertificateAuthorityBundleVersions(ListCertificateAuthorityBundleVersionsRequest request)

Description copied from interface: Certificates

Lists all certificate authority bundle versions for the specified certificate authority.

Specified by:

listCertificateAuthorityBundleVersions in interface Certificates

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listCertificateBundleVersions

public ListCertificateBundleVersionsResponse listCertificateBundleVersions(ListCertificateBundleVersionsRequest request)

Description copied from interface: Certificates

Lists all certificate bundle versions for the specified certificate.

Specified by:

listCertificateBundleVersions in interface Certificates

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

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.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()