Package com.azure.mixedreality.authentication

Class MixedRealityStsClientBuilder

java.lang.Object

com.azure.mixedreality.authentication.MixedRealityStsClientBuilder

All Implemented Interfaces:

AzureKeyCredentialTrait<MixedRealityStsClientBuilder>, ConfigurationTrait<MixedRealityStsClientBuilder>, EndpointTrait<MixedRealityStsClientBuilder>, HttpTrait<MixedRealityStsClientBuilder>, TokenCredentialTrait<MixedRealityStsClientBuilder>

public final class MixedRealityStsClientBuilder
extends Object
implements AzureKeyCredentialTrait<MixedRealityStsClientBuilder>, ConfigurationTrait<MixedRealityStsClientBuilder>, EndpointTrait<MixedRealityStsClientBuilder>, HttpTrait<MixedRealityStsClientBuilder>, TokenCredentialTrait<MixedRealityStsClientBuilder>

This class provides a fluent builder API to help aid the configuration and instantiation of MixedRealityStsClients and MixedRealityStsAsyncClient, call buildClient and buildAsyncClient respectively to construct an instance of the desired client.

See Also:

• MixedRealityStsAsyncClient
• MixedRealityStsClient

Constructor Summary

Constructors

Constructor	Description
MixedRealityStsClientBuilder()	Constructs a new builder used to configure and build MixedRealityStsClients and MixedRealityStsAsyncClients.

Method Summary

Modifier and Type	Method	Description
MixedRealityStsClientBuilder	accountDomain(String accountDomain)	Sets the Mixed Reality service account domain.
MixedRealityStsClientBuilder	accountId(String accountId)	Sets the Mixed Reality service account identifier.
MixedRealityStsClientBuilder	addPolicy(HttpPipelinePolicy customPolicy)	Adds a pipeline policy to apply on each request sent.
MixedRealityStsAsyncClient	buildAsyncClient()	Create a MixedRealityStsAsyncClient based on options set in the builder.
MixedRealityStsClient	buildClient()	Create a MixedRealityStsClient based on options set in the builder.
MixedRealityStsClientBuilder	clientOptions(ClientOptions clientOptions)	Allows for setting common properties such as application ID, headers, proxy configuration, etc.
MixedRealityStsClientBuilder	configuration(Configuration configuration)	Sets the configuration store that is used during construction of the service client.
MixedRealityStsClientBuilder	credential(AzureKeyCredential keyCredential)	Sets the AzureKeyCredential used to authenticate HTTP requests.
MixedRealityStsClientBuilder	credential(TokenCredential tokenCredential)	Sets the TokenCredential used to authorize requests sent to the service.
MixedRealityStsClientBuilder	endpoint(String endpoint)	Sets the Mixed Reality STS service endpoint.
MixedRealityStsClientBuilder	httpClient(HttpClient client)	Sets the HttpClient to use for sending and receiving requests to and from the service.
MixedRealityStsClientBuilder	httpLogOptions(HttpLogOptions logOptions)	Sets the logging configuration to use when sending and receiving requests to and from the service.
MixedRealityStsClientBuilder	pipeline(HttpPipeline pipeline)	Sets the HttpPipeline to use for the service client.
MixedRealityStsClientBuilder	retryOptions(RetryOptions retryOptions)	Sets the RetryOptions for all the requests made through the client.
MixedRealityStsClientBuilder	retryPolicy(RetryPolicy retryPolicy)	Sets the RetryPolicy that is used to retry requests.
MixedRealityStsClientBuilder	serviceVersion(MixedRealityStsServiceVersion version)	Sets the MixedRealityStsServiceVersion that is used when making API requests.

Methods inherited from class java.lang.Object

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

Constructor Details

MixedRealityStsClientBuilder

public MixedRealityStsClientBuilder()

Constructs a new builder used to configure and build MixedRealityStsClients and MixedRealityStsAsyncClients.

Method Details

accountDomain

public MixedRealityStsClientBuilder accountDomain(String accountDomain)

Sets the Mixed Reality service account domain.

Parameters:

accountDomain - The Mixed Reality service account domain.

Returns:

The updated MixedRealityStsClientBuilder object.

Throws:

IllegalArgumentException - If accountDomain is null or empty.

accountId

public MixedRealityStsClientBuilder accountId(String accountId)

Sets the Mixed Reality service account identifier.

Parameters:

accountId - The Mixed Reality service account identifier. The value is expected to be in UUID format.

Returns:

The updated MixedRealityStsClientBuilder object.

Throws:

IllegalArgumentException - If accountId is null or empty.

addPolicy

public MixedRealityStsClientBuilder addPolicy(HttpPipelinePolicy customPolicy)

Adds a pipeline policy to apply on each request sent.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is 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 an HttpPipeline is 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:

addPolicy in interface HttpTrait<MixedRealityStsClientBuilder>

Parameters:

customPolicy - A pipeline policy.

Returns:

The updated MixedRealityStsClientBuilder object.

buildClient

public MixedRealityStsClient buildClient()

Create a MixedRealityStsClient based on options set in the builder. Every time buildClient() is called a new instance of MixedRealityStsClient is created.

Returns:

A MixedRealityStsClient with the options set from the builder.

Throws:

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

buildAsyncClient

public MixedRealityStsAsyncClient buildAsyncClient()

Create a MixedRealityStsAsyncClient based on options set in the builder. Every time buildAsyncClient() is called a new instance of MixedRealityStsAsyncClient is created.

Returns:

A MixedRealityStsAsyncClient with the options set from the builder.

Throws:

NullPointerException - If any required values are null.

IllegalArgumentException - If the accountId or endpoint are not properly formatted.

IllegalStateException - If both retryOptions(RetryOptions) and retryPolicy(RetryPolicy) have been set.

clientOptions

public MixedRealityStsClientBuilder clientOptions(ClientOptions 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 the HttpClientOptions class (a subclass of the ClientOptions base 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 HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is 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 an HttpPipeline is 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:

clientOptions in interface HttpTrait<MixedRealityStsClientBuilder>

Parameters:

clientOptions - A configured instance of HttpClientOptions.

Returns:

The updated MixedRealityStsClientBuilder object.

See Also:

• HttpClientOptions

credential

public MixedRealityStsClientBuilder credential(TokenCredential tokenCredential)

Sets the TokenCredential used 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 the TokenCredential type.

Specified by:

credential in interface TokenCredentialTrait<MixedRealityStsClientBuilder>

Parameters:

tokenCredential - TokenCredential used to authorize requests sent to the service.

Returns:

The updated MixedRealityStsClientBuilder object.

Throws:

NullPointerException - If tokenCredential is null.

credential

public MixedRealityStsClientBuilder credential(AzureKeyCredential keyCredential)

Sets the AzureKeyCredential used to authenticate HTTP requests.

Note: Not recommended for production applications.

Specified by:

credential in interface AzureKeyCredentialTrait<MixedRealityStsClientBuilder>

Parameters:

keyCredential - The AzureKeyCredential used to authenticate HTTP requests.

Returns:

The updated MixedRealityStsClientBuilder object.

Throws:

NullPointerException - If keyCredential is null.

configuration

public MixedRealityStsClientBuilder configuration(Configuration configuration)

Sets the configuration store that is used during construction of the service client. The default configuration store is a clone of the global configuration store, use Configuration.NONE to bypass using configuration settings during construction.

Specified by:

configuration in interface ConfigurationTrait<MixedRealityStsClientBuilder>

Parameters:

configuration - The configuration store used to

Returns:

The updated MixedRealityStsClientBuilder object.

endpoint

public MixedRealityStsClientBuilder endpoint(String endpoint)

Sets the Mixed Reality STS service endpoint.

Specified by:

endpoint in interface EndpointTrait<MixedRealityStsClientBuilder>

Parameters:

endpoint - The Mixed Reality STS service endpoint.

Returns:

The updated MixedRealityStsClientBuilder object.

Throws:

IllegalArgumentException - If endpoint is null or it cannot be parsed into a valid URL.

httpClient

public MixedRealityStsClientBuilder httpClient(HttpClient client)

Sets the HttpClient to 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 HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is 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 an HttpPipeline is 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:

httpClient in interface HttpTrait<MixedRealityStsClientBuilder>

Parameters:

client - The HttpClient to use for requests.

Returns:

The updated ConfigurationClientBuilder object.

httpLogOptions

public MixedRealityStsClientBuilder httpLogOptions(HttpLogOptions logOptions)

Sets the logging configuration to use when sending and receiving requests to and from the service. If a logLevel is not provided, default value of HttpLogDetailLevel.NONE is set.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is 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 an HttpPipeline is 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:

httpLogOptions in interface HttpTrait<MixedRealityStsClientBuilder>

Parameters:

logOptions - The logging configuration to use when sending and receiving requests to and from the service.

Returns:

The updated MixedRealityStsClientBuilder object.

pipeline

public MixedRealityStsClientBuilder pipeline(HttpPipeline pipeline)

Sets the HttpPipeline to use for the service client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is 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 an HttpPipeline is specified, so please be sure to refer to the documentation of types that implement this trait to understand the full set of implications.

If pipeline is set, all other settings are ignored, aside from endpoint to build MixedRealityStsAsyncClient or MixedRealityStsClient.

Specified by:

pipeline in interface HttpTrait<MixedRealityStsClientBuilder>

Parameters:

pipeline - HttpPipeline to use for sending service requests and receiving responses.

Returns:

The updated MixedRealityStsClientBuilder object.

retryPolicy

public MixedRealityStsClientBuilder retryPolicy(RetryPolicy retryPolicy)

Sets the RetryPolicy that is used to retry requests.

The default retry policy will be used if not provided buildAsyncClient() to build MixedRealityStsAsyncClient or MixedRealityStsClient.

Setting this is mutually exclusive with using retryOptions(RetryOptions).

Parameters:

retryPolicy - The RetryPolicy that will be used to retry requests.

Returns:

The updated MixedRealityStsClientBuilder object.

retryOptions

public MixedRealityStsClientBuilder retryOptions(RetryOptions retryOptions)

Sets the RetryOptions for all the requests made through the client.

Note: It is important to understand the precedence order of the HttpTrait APIs. In particular, if a HttpPipeline is specified, this takes precedence over all other APIs in the trait, and they will be ignored. If no HttpPipeline is 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 an HttpPipeline is 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:

retryOptions in interface HttpTrait<MixedRealityStsClientBuilder>

Parameters:

retryOptions - The RetryOptions to use for all the requests made through the client.

Returns:

The updated MixedRealityStsClientBuilder object.

serviceVersion

public MixedRealityStsClientBuilder serviceVersion(MixedRealityStsServiceVersion version)

Sets the MixedRealityStsServiceVersion 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 - MixedRealityStsServiceVersion of the service to be used when making requests.

Returns:

The updated ConfigurationClientBuilder object.