Class CertificateClientBuilder
- All Implemented Interfaces:
ConfigurationTrait<CertificateClientBuilder>,HttpTrait<CertificateClientBuilder>,TokenCredentialTrait<CertificateClientBuilder>
certificate async client and certificate sync client,
by calling buildAsyncClient and buildClient respectively
It constructs an instance of the desired client.
The minimal configuration options required by CertificateClientBuilder to build CertificateAsyncClient
are vaultUrl and credential.
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 custom policies and custom
http client can be optionally configured in the CertificateClientBuilder.
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 custom HttpPipelinePolicy policies and
vaultUrl
can be specified. It provides finer control over the construction of CertificateAsyncClient and CertificateClient
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 build
CertificateClient
are vaultUrl and credential.
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:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddPolicy(HttpPipelinePolicy policy) Adds apipeline policyto apply on each request sent.Creates aCertificateAsyncClientbased on options set in the builder.Creates aCertificateClientbased on options set in the builder.clientOptions(ClientOptions clientOptions) Allows for setting common properties such as application ID, headers, proxy configuration, etc.configuration(Configuration configuration) Sets the configuration store that is used during construction of the service client.credential(TokenCredential credential) Sets theTokenCredentialused to authorize requests sent to the service.httpClient(HttpClient client) Sets theHttpClientto use for sending and receiving requests to and from the service.httpLogOptions(HttpLogOptions logOptions) Sets thelogging configurationto use when sending and receiving requests to and from the service.pipeline(HttpPipeline pipeline) Sets theHttpPipelineto use for the service client.retryOptions(RetryOptions retryOptions) Sets theRetryOptionsfor all the requests made through the client.retryPolicy(RetryPolicy retryPolicy) Sets theRetryPolicythat is used when each request is sent.serviceVersion(CertificateServiceVersion version) Sets theCertificateServiceVersionthat is used when making API requests.Sets the vault endpoint URL to send HTTP requests to.
-
Constructor Details
-
CertificateClientBuilder
public CertificateClientBuilder()The constructor with defaults.
-
-
Method Details
-
buildClient
Creates aCertificateClientbased on options set in the builder. Every timebuildClient()is called, a new instance ofCertificateClientis created.If
pipelineis set, then thepipelineandserviceEndpointare used to create theclient. All other builder settings are ignored. Ifpipelineis not set, thenkey vault credentialandkey vault urlare required to build theclient.- Returns:
- A
CertificateClientwith the options set from the builder. - Throws:
IllegalStateException- Ifcredential(TokenCredential)orvaultUrl(String)have not been set.IllegalStateException- If bothretryOptions(RetryOptions)andretryPolicy(RetryPolicy)have been set.
-
buildAsyncClient
Creates aCertificateAsyncClientbased on options set in the builder. Every timebuildAsyncClient()is called, a new instance ofCertificateAsyncClientis created.If
pipelineis set, then thepipelineandserviceEndpointare used to create theclient. All other builder settings are ignored. Ifpipelineis not set, thenkey vault credentialandvaultUrl(String)key vault url are required to build theclient.- Returns:
- A
CertificateAsyncClientwith the options set from the builder. - Throws:
IllegalStateException- Ifcredential(TokenCredential)orvaultUrl(String)have not been set.IllegalStateException- If bothretryOptions(RetryOptions)andretryPolicy(RetryPolicy)have been set.
-
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 newKeyVaultCertificateIdentifierto parse it and obtain thevaultUrland other information.- Returns:
- The updated
CertificateClientBuilderobject. - Throws:
IllegalArgumentException- ifvaultUrlis null or it cannot be parsed into a valid URL.
-
credential
Sets theTokenCredentialused to authorize requests sent to the service. Refer to the Azure SDK for Java identity and authentication documentation for more details on proper usage of theTokenCredentialtype.- Specified by:
credentialin interfaceTokenCredentialTrait<CertificateClientBuilder>- Parameters:
credential-TokenCredentialused to authorize requests sent to the service.- Returns:
- The updated
CertificateClientBuilderobject. - Throws:
NullPointerException- Ifcredentialisnull.
-
httpLogOptions
Sets thelogging configurationto use when sending and receiving requests to and from the service. If alogLevelis not provided, default value ofHttpLogDetailLevel.NONEis set.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpLogOptionsin interfaceHttpTrait<CertificateClientBuilder>- Parameters:
logOptions- Thelogging configurationto use when sending and receiving requests to and from the service.- Returns:
- The updated
CertificateClientBuilderobject.
-
addPolicy
Adds apipeline policyto apply on each request sent.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
addPolicyin interfaceHttpTrait<CertificateClientBuilder>- Parameters:
policy- Apipeline policy.- Returns:
- The updated
CertificateClientBuilderobject. - Throws:
NullPointerException- Ifpolicyisnull.
-
httpClient
Sets theHttpClientto use for sending and receiving requests to and from the service.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
httpClientin interfaceHttpTrait<CertificateClientBuilder>- Parameters:
client- TheHttpClientto use for requests.- Returns:
- The updated
CertificateClientBuilderobject.
-
pipeline
Sets theHttpPipelineto use for the service client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.The
vaultUrlis not ignored whenpipelineis set.- Specified by:
pipelinein interfaceHttpTrait<CertificateClientBuilder>- Parameters:
pipeline-HttpPipelineto use for sending service requests and receiving responses.- Returns:
- The updated
CertificateClientBuilderobject.
-
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.NONEto bypass using configuration settings during construction.- Specified by:
configurationin interfaceConfigurationTrait<CertificateClientBuilder>- Parameters:
configuration- The configuration store used to get configuration details.- Returns:
- The updated
CertificateClientBuilderobject.
-
serviceVersion
Sets theCertificateServiceVersionthat 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-CertificateServiceVersionof the service to be used when making requests.- Returns:
- The updated
CertificateClientBuilderobject.
-
retryPolicy
Sets theRetryPolicythat is used when each request is sent. The default retry policy will be used in the pipeline, if not provided. Setting this is mutually exclusive with usingretryOptions(RetryOptions).- Parameters:
retryPolicy- user's retry policy applied to each request.- Returns:
- The updated
CertificateClientBuilderobject.
-
retryOptions
Sets theRetryOptionsfor all the requests made through the client.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.Setting this is mutually exclusive with using
retryPolicy(RetryPolicy).- Specified by:
retryOptionsin interfaceHttpTrait<CertificateClientBuilder>- Parameters:
retryOptions- TheRetryOptionsto use for all the requests made through the client.- Returns:
- The updated
CertificateClientBuilderobject.
-
clientOptions
Allows for setting common properties such as application ID, headers, proxy configuration, etc. Note that it is recommended that this method be called with an instance of theHttpClientOptionsclass (a subclass of theClientOptionsbase class). The HttpClientOptions subclass provides more configuration options suitable for HTTP clients, which is applicable for any class that implements this HttpTrait interface.Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a
HttpPipelineis specified, this takes precedence over all other APIs in the trait, and they will be ignored. If noHttpPipelineis specified, a HTTP pipeline will be constructed internally based on the settings provided to this trait. Additionally, there may be other APIs in types that implement this trait that are also ignored if anHttpPipelineis specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.- Specified by:
clientOptionsin interfaceHttpTrait<CertificateClientBuilder>- Parameters:
clientOptions- A configured instance ofHttpClientOptions.- Returns:
- The updated
CertificateClientBuilderobject. - See Also:
-