com.azure.communication.messages.NotificationMessagesClientBuilder Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) TypeSpec Code Generator.
package com.azure.communication.messages;
import com.azure.communication.common.implementation.CommunicationConnectionString;
import com.azure.communication.common.implementation.HmacAuthenticationPolicy;
import com.azure.communication.messages.implementation.NotificationMessagesClientImpl;
import com.azure.core.annotation.Generated;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.client.traits.ConfigurationTrait;
import com.azure.core.client.traits.ConnectionStringTrait;
import com.azure.core.client.traits.EndpointTrait;
import com.azure.core.client.traits.HttpTrait;
import com.azure.core.client.traits.KeyCredentialTrait;
import com.azure.core.client.traits.TokenCredentialTrait;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.credential.KeyCredential;
import com.azure.core.credential.TokenCredential;
import com.azure.core.http.HttpClient;
import com.azure.core.http.HttpHeaderName;
import com.azure.core.http.HttpHeaders;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.HttpPipelineBuilder;
import com.azure.core.http.HttpPipelinePosition;
import com.azure.core.http.policy.AddDatePolicy;
import com.azure.core.http.policy.AddHeadersFromContextPolicy;
import com.azure.core.http.policy.AddHeadersPolicy;
import com.azure.core.http.policy.BearerTokenAuthenticationPolicy;
import com.azure.core.http.policy.HttpLogOptions;
import com.azure.core.http.policy.HttpLoggingPolicy;
import com.azure.core.http.policy.HttpPipelinePolicy;
import com.azure.core.http.policy.HttpPolicyProviders;
import com.azure.core.http.policy.RequestIdPolicy;
import com.azure.core.http.policy.RetryOptions;
import com.azure.core.http.policy.RetryPolicy;
import com.azure.core.http.policy.UserAgentPolicy;
import com.azure.core.util.ClientOptions;
import com.azure.core.util.Configuration;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.builder.ClientBuilderUtil;
import com.azure.core.util.logging.ClientLogger;
import com.azure.core.util.serializer.JacksonAdapter;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* A builder for creating a new instance of the NotificationMessagesClient type.
*/
@ServiceClientBuilder(serviceClients = { NotificationMessagesClient.class, NotificationMessagesAsyncClient.class })
public final class NotificationMessagesClientBuilder
implements HttpTrait, ConfigurationTrait,
TokenCredentialTrait, KeyCredentialTrait,
EndpointTrait, ConnectionStringTrait {
@Generated
private static final String SDK_NAME = "name";
@Generated
private static final String SDK_VERSION = "version";
@Generated
private static final String[] DEFAULT_SCOPES = new String[] { "https://communication.azure.com/.default" };
@Generated
private static final Map PROPERTIES
= CoreUtils.getProperties("azure-communication-messages.properties");
@Generated
private final List pipelinePolicies;
/**
* Create an instance of the NotificationMessagesClientBuilder.
*/
@Generated
public NotificationMessagesClientBuilder() {
this.pipelinePolicies = new ArrayList<>();
}
/*
* The HTTP pipeline to send requests through.
*/
@Generated
private HttpPipeline pipeline;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder pipeline(HttpPipeline pipeline) {
if (this.pipeline != null && pipeline == null) {
LOGGER.atInfo().log("HttpPipeline is being set to 'null' when it was previously configured.");
}
this.pipeline = pipeline;
return this;
}
/*
* The HTTP client used to send the request.
*/
@Generated
private HttpClient httpClient;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder httpClient(HttpClient httpClient) {
this.httpClient = httpClient;
return this;
}
/*
* The logging configuration for HTTP requests and responses.
*/
@Generated
private HttpLogOptions httpLogOptions;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder httpLogOptions(HttpLogOptions httpLogOptions) {
this.httpLogOptions = httpLogOptions;
return this;
}
/*
* The client options such as application ID and custom headers to set on a request.
*/
@Generated
private ClientOptions clientOptions;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder clientOptions(ClientOptions clientOptions) {
this.clientOptions = clientOptions;
return this;
}
/*
* The retry options to configure retry policy for failed requests.
*/
@Generated
private RetryOptions retryOptions;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder retryOptions(RetryOptions retryOptions) {
this.retryOptions = retryOptions;
return this;
}
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder addPolicy(HttpPipelinePolicy customPolicy) {
Objects.requireNonNull(customPolicy, "'customPolicy' cannot be null.");
pipelinePolicies.add(customPolicy);
return this;
}
/*
* The configuration store that is used during construction of the service client.
*/
@Generated
private Configuration configuration;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder configuration(Configuration configuration) {
this.configuration = configuration;
return this;
}
/*
* The TokenCredential used for authentication.
*/
@Generated
private TokenCredential tokenCredential;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder credential(TokenCredential tokenCredential) {
this.tokenCredential = tokenCredential;
return this;
}
/*
* The KeyCredential used for authentication.
*/
@Generated
private KeyCredential keyCredential;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder credential(KeyCredential keyCredential) {
this.keyCredential = keyCredential;
return this;
}
/*
* The service endpoint
*/
@Generated
private String endpoint;
/**
* {@inheritDoc}.
*/
@Generated
@Override
public NotificationMessagesClientBuilder endpoint(String endpoint) {
this.endpoint = endpoint;
return this;
}
/*
* Service version
*/
@Generated
private MessagesServiceVersion serviceVersion;
/**
* Sets Service version.
*
* @param serviceVersion the serviceVersion value.
* @return the NotificationMessagesClientBuilder.
*/
@Generated
public NotificationMessagesClientBuilder serviceVersion(MessagesServiceVersion serviceVersion) {
this.serviceVersion = serviceVersion;
return this;
}
/*
* The retry policy that will attempt to retry failed requests, if applicable.
*/
@Generated
private RetryPolicy retryPolicy;
/**
* Sets The retry policy that will attempt to retry failed requests, if applicable.
*
* @param retryPolicy the retryPolicy value.
* @return the NotificationMessagesClientBuilder.
*/
@Generated
public NotificationMessagesClientBuilder retryPolicy(RetryPolicy retryPolicy) {
this.retryPolicy = retryPolicy;
return this;
}
/**
* Builds an instance of NotificationMessagesClientImpl with the provided parameters.
*
* @return an instance of NotificationMessagesClientImpl.
*/
@Generated
private NotificationMessagesClientImpl buildInnerClient() {
this.validateClient();
HttpPipeline localPipeline = (pipeline != null) ? pipeline : createHttpPipeline();
MessagesServiceVersion localServiceVersion
= (serviceVersion != null) ? serviceVersion : MessagesServiceVersion.getLatest();
NotificationMessagesClientImpl client = new NotificationMessagesClientImpl(localPipeline,
JacksonAdapter.createDefaultSerializerAdapter(), this.endpoint, localServiceVersion);
return client;
}
@Generated
private void validateClient() {
// This method is invoked from 'buildInnerClient'/'buildClient' method.
// Developer can customize this method, to validate that the necessary conditions are met for the new client.
Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
}
@Generated
private HttpPipeline createHttpPipeline() {
Configuration buildConfiguration
= (configuration == null) ? Configuration.getGlobalConfiguration() : configuration;
HttpLogOptions localHttpLogOptions = this.httpLogOptions == null ? new HttpLogOptions() : this.httpLogOptions;
ClientOptions localClientOptions = this.clientOptions == null ? new ClientOptions() : this.clientOptions;
List policies = new ArrayList<>();
String clientName = PROPERTIES.getOrDefault(SDK_NAME, "UnknownName");
String clientVersion = PROPERTIES.getOrDefault(SDK_VERSION, "UnknownVersion");
String applicationId = CoreUtils.getApplicationId(localClientOptions, localHttpLogOptions);
policies.add(new UserAgentPolicy(applicationId, clientName, clientVersion, buildConfiguration));
policies.add(new RequestIdPolicy());
policies.add(new AddHeadersFromContextPolicy());
HttpHeaders headers = new HttpHeaders();
localClientOptions.getHeaders()
.forEach(header -> headers.set(HttpHeaderName.fromString(header.getName()), header.getValue()));
if (headers.getSize() > 0) {
policies.add(new AddHeadersPolicy(headers));
}
this.pipelinePolicies.stream()
.filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL)
.forEach(p -> policies.add(p));
HttpPolicyProviders.addBeforeRetryPolicies(policies);
policies.add(ClientBuilderUtil.validateAndGetRetryPolicy(retryPolicy, retryOptions, new RetryPolicy()));
policies.add(new AddDatePolicy());
policies.add(createHttpPipelineAuthPolicy());
this.pipelinePolicies.stream()
.filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_RETRY)
.forEach(p -> policies.add(p));
HttpPolicyProviders.addAfterRetryPolicies(policies);
policies.add(new HttpLoggingPolicy(localHttpLogOptions));
HttpPipeline httpPipeline = new HttpPipelineBuilder().policies(policies.toArray(new HttpPipelinePolicy[0]))
.httpClient(httpClient)
.clientOptions(localClientOptions)
.build();
return httpPipeline;
}
/**
* Builds an instance of NotificationMessagesAsyncClient class.
*
* @return an instance of NotificationMessagesAsyncClient.
*/
@Generated
public NotificationMessagesAsyncClient buildAsyncClient() {
return new NotificationMessagesAsyncClient(buildInnerClient());
}
/**
* Builds an instance of NotificationMessagesClient class.
*
* @return an instance of NotificationMessagesClient.
*/
@Generated
public NotificationMessagesClient buildClient() {
return new NotificationMessagesClient(buildInnerClient());
}
/**
* Set a connection string for authorization.
*
* @param connectionString valid connectionString as a string.
* @return the updated NotificationMessagesClientBuilder object.
*/
@Override
public NotificationMessagesClientBuilder connectionString(String connectionString) {
CommunicationConnectionString connection = new CommunicationConnectionString(connectionString);
this.credential(new KeyCredential(connection.getAccessKey()));
this.endpoint(connection.getEndpoint());
return this;
}
private HttpPipelinePolicy createHttpPipelineAuthPolicy() {
if (tokenCredential != null) {
return new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES);
} else if (keyCredential != null) {
return new HmacAuthenticationPolicy(new AzureKeyCredential(keyCredential.getKey()));
} else {
throw LOGGER.logExceptionAsError(
new IllegalStateException("Missing credential information while building a client."));
}
}
private static final ClientLogger LOGGER = new ClientLogger(NotificationMessagesClientBuilder.class);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy