Class CertificateClientBuilder
- java.lang.Object
-
- com.azure.security.keyvault.certificates.CertificateClientBuilder
-
public final class CertificateClientBuilder extends Object
This class provides a fluent builder API to help aid the configuration and instantiation of thecertificate async client
andcertificate sync client
, by callingbuildAsyncClient
andbuildClient
respectively It constructs an instance of the desired client.The minimal configuration options required by
CertificateClientBuilder
to buildCertificateAsyncClient
arevaultUrl
andcredential
.CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder() .credential(new DefaultAzureCredentialBuilder().build()) .vaultUrl("https://myvault.vault.azure.net/") .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS)) .buildAsyncClient();
The
log detail level
, multiple custompolicies
and customhttp client
can be optionally configured in theCertificateClientBuilder
.CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder() .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS)) .vaultUrl("https://myvault.azure.net/") .credential(new DefaultAzureCredentialBuilder().build()) .httpClient(HttpClient.createDefault()) .buildAsyncClient();
Alternatively, custom
http pipeline
with customHttpPipelinePolicy
policies andvaultUrl
can be specified. It provides finer control over the construction ofCertificateAsyncClient
andCertificateClient
HttpPipeline pipeline = new HttpPipelineBuilder() .policies(new KeyVaultCredentialPolicy(new DefaultAzureCredentialBuilder().build()), new RetryPolicy()) .build(); CertificateAsyncClient certificateAsyncClient = new CertificateClientBuilder() .pipeline(pipeline) .vaultUrl("https://myvault.azure.net/") .buildAsyncClient();
The minimal configuration options required by
certificateClientBuilder
to buildCertificateClient
arevaultUrl
andcredential
.CertificateClient certificateClient = new CertificateClientBuilder() .credential(new DefaultAzureCredentialBuilder().build()) .vaultUrl("https://myvault.vault.azure.net/") .httpLogOptions(new HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS)) .buildClient();
- See Also:
CertificateAsyncClient
,CertificateClient
-
-
Constructor Summary
Constructors Constructor Description CertificateClientBuilder()
The constructor with defaults.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CertificateClientBuilder
addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds a policy to the set of existing policies that are executed afterCertificateAsyncClient
andCertificateClient
required policies.CertificateAsyncClient
buildAsyncClient()
Creates aCertificateAsyncClient
based on options set in the builder.CertificateClient
buildClient()
Creates aCertificateClient
based on options set in the builder.CertificateClientBuilder
clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets theClientOptions
which enables various options to be set on the client.CertificateClientBuilder
configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client.CertificateClientBuilder
credential(com.azure.core.credential.TokenCredential credential)
Sets the credential to use when authenticating HTTP requests.CertificateClientBuilder
httpClient(com.azure.core.http.HttpClient client)
Sets the HTTP client to use for sending and receiving requests to and from the service.CertificateClientBuilder
httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.CertificateClientBuilder
pipeline(com.azure.core.http.HttpPipeline pipeline)
Sets the HTTP pipeline to use for the service client.CertificateClientBuilder
retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theRetryPolicy
that is used when each request is sent.CertificateClientBuilder
serviceVersion(CertificateServiceVersion version)
Sets theCertificateServiceVersion
that is used when making API requests.CertificateClientBuilder
vaultUrl(String vaultUrl)
Sets the vault endpoint URL to send HTTP requests to.
-
-
-
Method Detail
-
buildClient
public CertificateClient buildClient()
Creates aCertificateClient
based on options set in the builder. Every timebuildClient()
is called, a new instance ofCertificateClient
is created.If
pipeline
is set, then thepipeline
andserviceEndpoint
are used to create theclient
. All other builder settings are ignored. Ifpipeline
is not set, thenkey vault credential
andkey vault url
are required to build theclient
.- Returns:
- A
CertificateClient
with the options set from the builder. - Throws:
IllegalStateException
- Ifcredential(TokenCredential)
orvaultUrl(String)
have not been set.
-
buildAsyncClient
public CertificateAsyncClient buildAsyncClient()
Creates aCertificateAsyncClient
based on options set in the builder. Every timebuildAsyncClient()
is called, a new instance ofCertificateAsyncClient
is created.If
pipeline
is set, then thepipeline
andserviceEndpoint
are used to create theclient
. All other builder settings are ignored. Ifpipeline
is not set, thenkey vault credential
andvaultUrl(String)
key vault url are required to build theclient
.- Returns:
- A
CertificateAsyncClient
with the options set from the builder. - Throws:
IllegalStateException
- Ifcredential(TokenCredential)
orvaultUrl(String)
have not been set.
-
vaultUrl
public CertificateClientBuilder vaultUrl(String vaultUrl)
Sets the vault endpoint URL to send HTTP requests to.- Parameters:
vaultUrl
- The vault endpoint url is used as destination on Azure to send requests to. If you have a certificate identifier, create a newKeyVaultCertificateIdentifier
to parse it and obtain thevaultUrl
and other information.- Returns:
- The updated
CertificateClientBuilder
object. - Throws:
IllegalArgumentException
- ifvaultUrl
is null or it cannot be parsed into a valid URL.
-
credential
public CertificateClientBuilder credential(com.azure.core.credential.TokenCredential credential)
Sets the credential to use when authenticating HTTP requests.- Parameters:
credential
- The credential to use for authenticating HTTP requests.- Returns:
- The updated
CertificateClientBuilder
object. - Throws:
NullPointerException
- Ifcredential
isnull
.
-
httpLogOptions
public CertificateClientBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
Sets the logging configuration for HTTP requests and responses.If logLevel is not provided, default value of
HttpLogDetailLevel.NONE
is set.- Parameters:
logOptions
- The logging configuration to use when sending and receiving HTTP requests/responses.- Returns:
- The updated
CertificateClientBuilder
object.
-
addPolicy
public CertificateClientBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
Adds a policy to the set of existing policies that are executed afterCertificateAsyncClient
andCertificateClient
required policies.- Parameters:
policy
- Thepolicy
to be added.- Returns:
- The updated
CertificateClientBuilder
object. - Throws:
NullPointerException
- Ifpolicy
isnull
.
-
httpClient
public CertificateClientBuilder httpClient(com.azure.core.http.HttpClient client)
Sets the HTTP client to use for sending and receiving requests to and from the service.- Parameters:
client
- The HTTP client to use for requests.- Returns:
- The updated
CertificateClientBuilder
object.
-
pipeline
public CertificateClientBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)
Sets the HTTP pipeline to use for the service client. Ifpipeline
is set, all other settings are ignored, aside fromvaultUrl
to buildCertificateClient
orCertificateAsyncClient
.- Parameters:
pipeline
- The HTTP pipeline to use for sending service requests and receiving responses.- Returns:
- The updated
CertificateClientBuilder
object.
-
configuration
public CertificateClientBuilder configuration(com.azure.core.util.Configuration configuration)
Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of theglobal configuration store
, useConfiguration.NONE
to bypass using configuration settings during construction.- Parameters:
configuration
- The configuration store used to get configuration details.- Returns:
- The updated
CertificateClientBuilder
object.
-
serviceVersion
public CertificateClientBuilder serviceVersion(CertificateServiceVersion version)
Sets theCertificateServiceVersion
that is used when making API requests.If a service version is not provided, the service version that will be used will be the latest known service version based on the version of the client library being used. If no service version is specified, updating to a newer version the client library will have the result of potentially moving to a newer service version.
- Parameters:
version
-CertificateServiceVersion
of the service to be used when making requests.- Returns:
- The updated
CertificateClientBuilder
object.
-
retryPolicy
public CertificateClientBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
Sets theRetryPolicy
that is used when each request is sent. The default retry policy will be used in the pipeline, if not provided.- Parameters:
retryPolicy
- user's retry policy applied to each request.- Returns:
- The updated
CertificateClientBuilder
object.
-
clientOptions
public CertificateClientBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)
Sets theClientOptions
which enables various options to be set on the client. For example setting anapplicationId
usingClientOptions.setApplicationId(String)
to configure theUserAgentPolicy
for telemetry/monitoring purposes.More About Azure Core: Telemetry policy
- Parameters:
clientOptions
- theClientOptions
to be set on the client.- Returns:
- The updated
CertificateClientBuilder
object.
-
-