SearchClientBuilder.java
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.search.documents;
import com.azure.core.annotation.ServiceClientBuilder;
import com.azure.core.credential.AzureKeyCredential;
import com.azure.core.http.HttpClient;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.HttpPipelinePosition;
import com.azure.core.http.policy.HttpLogOptions;
import com.azure.core.http.policy.HttpPipelinePolicy;
import com.azure.core.http.policy.RetryPolicy;
import com.azure.core.util.ClientOptions;
import com.azure.core.util.Configuration;
import com.azure.core.util.CoreUtils;
import com.azure.core.util.logging.ClientLogger;
import com.azure.core.util.serializer.JsonSerializer;
import com.azure.search.documents.implementation.util.Constants;
import com.azure.search.documents.implementation.util.Utility;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
/**
* This class provides a fluent builder API to help aid the configuration and instantiation of {@link SearchClient
* SearchClients} and {@link SearchAsyncClient SearchAsyncClients}. Call {@link #buildClient() buildClient} and {@link
* #buildAsyncClient() buildAsyncClient} respectively to construct an instance of the desired client.
* <p>
* The following must be provided to construct a client instance.
* <ul>
* <li>The Azure Cognitive Search service URL.</li>
* <li>An {@link AzureKeyCredential} that grants access to the Azure Cognitive Search service.</li>
* <li>The search index name.</li>
* </ul>
*
* <p><strong>Instantiating an asynchronous Search Client</strong></p>
*
* {@codesnippet com.azure.search.documents.SearchAsyncClient.instantiation}
*
* <p><strong>Instantiating a synchronous Search Client</strong></p>
*
* {@codesnippet com.azure.search.documents.SearchClient.instantiation}
*
* @see SearchClient
* @see SearchAsyncClient
*/
@ServiceClientBuilder(serviceClients = {SearchClient.class, SearchAsyncClient.class})
public final class SearchClientBuilder {
private final ClientLogger logger = new ClientLogger(SearchClientBuilder.class);
private final List<HttpPipelinePolicy> perCallPolicies = new ArrayList<>();
private final List<HttpPipelinePolicy> perRetryPolicies = new ArrayList<>();
private AzureKeyCredential credential;
private SearchServiceVersion serviceVersion;
private String endpoint;
private HttpClient httpClient;
private HttpPipeline httpPipeline;
private ClientOptions clientOptions;
private HttpLogOptions httpLogOptions;
private Configuration configuration;
private String indexName;
private RetryPolicy retryPolicy;
private JsonSerializer jsonSerializer;
/**
* Creates a builder instance that is able to configure and construct {@link SearchClient SearchClients} and {@link
* SearchAsyncClient SearchAsyncClients}.
*/
public SearchClientBuilder() {
}
/**
* Creates a {@link SearchClient} based on options set in the builder. Every time {@code buildClient()} is called a
* new instance of {@link SearchClient} is created.
* <p>
* If {@link #pipeline(HttpPipeline) pipeline} is set, then only the {@code pipeline}, {@link #endpoint(String)
* endpoint}, and {@link #indexName(String) indexName} are used to create the {@link SearchClient client}. All other
* builder settings are ignored.
*
* @return A SearchClient with the options set from the builder.
* @throws NullPointerException If {@code indexName} or {@code endpoint} are {@code null}.
*/
public SearchClient buildClient() {
return new SearchClient(buildAsyncClient());
}
/**
* Creates a {@link SearchAsyncClient} based on options set in the builder. Every time {@code buildAsyncClient()} is
* called a new instance of {@link SearchAsyncClient} is created.
* <p>
* If {@link #pipeline(HttpPipeline) pipeline} is set, then only the {@code pipeline}, {@link #endpoint(String)
* endpoint}, and {@link #indexName(String) indexName} are used to create the {@link SearchAsyncClient client}. All
* other builder settings are ignored.
*
* @return A SearchClient with the options set from the builder.
* @throws NullPointerException If {@code indexName} or {@code endpoint} are {@code null}.
*/
public SearchAsyncClient buildAsyncClient() {
Objects.requireNonNull(indexName, "'indexName' cannot be null.");
Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
SearchServiceVersion buildVersion = (serviceVersion == null)
? SearchServiceVersion.getLatest()
: serviceVersion;
if (httpPipeline != null) {
return new SearchAsyncClient(endpoint, indexName, buildVersion, httpPipeline, jsonSerializer);
}
Objects.requireNonNull(credential, "'credential' cannot be null.");
HttpPipeline pipeline = Utility.buildHttpPipeline(clientOptions, httpLogOptions, configuration, retryPolicy,
credential, perCallPolicies, perRetryPolicies, httpClient);
return new SearchAsyncClient(endpoint, indexName, buildVersion, pipeline, jsonSerializer);
}
/**
* Sets the service endpoint for the Azure Cognitive Search instance.
*
* @param endpoint The URL of the Azure Cognitive Search instance.
* @return The updated SearchClientBuilder object.
* @throws IllegalArgumentException If {@code endpoint} is null or it cannot be parsed into a valid URL.
*/
public SearchClientBuilder endpoint(String endpoint) {
try {
new URL(endpoint);
} catch (MalformedURLException ex) {
throw logger.logExceptionAsWarning(new IllegalArgumentException("'endpoint' must be a valid URL"));
}
this.endpoint = endpoint;
return this;
}
/**
* Sets the {@link AzureKeyCredential} used to authenticate HTTP requests.
*
* @param credential The {@link AzureKeyCredential} used to authenticate HTTP requests.
* @return The updated SearchClientBuilder object.
* @throws NullPointerException If {@code credential} is {@code null}.
* @throws IllegalArgumentException If {@link AzureKeyCredential#getKey()} is {@code null} or empty.
*/
public SearchClientBuilder credential(AzureKeyCredential credential) {
Objects.requireNonNull(credential, "'credential' cannot be null.");
this.credential = credential;
return this;
}
/**
* Sets the name of the index.
*
* @param indexName Name of the index.
* @return The updated SearchClientBuilder object.
* @throws IllegalArgumentException If {@code indexName} is {@code null} or empty.
*/
public SearchClientBuilder indexName(String indexName) {
if (CoreUtils.isNullOrEmpty(indexName)) {
throw logger.logExceptionAsError(new IllegalArgumentException("'indexName' cannot be null or empty."));
}
this.indexName = indexName;
return this;
}
/**
* Sets the logging configuration for HTTP requests and responses.
* <p>
* If logging configurations aren't provided HTTP requests and responses won't be logged.
*
* @param logOptions The logging configuration for HTTP requests and responses.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder httpLogOptions(HttpLogOptions logOptions) {
httpLogOptions = logOptions;
return this;
}
/**
* Gets the default Azure Search headers and query parameters allow list.
*
* @return The default {@link HttpLogOptions} allow list.
*/
public static HttpLogOptions getDefaultLogOptions() {
return Constants.DEFAULT_LOG_OPTIONS_SUPPLIER.get();
}
/**
* Sets the client options such as application ID and custom headers to set on a request.
*
* @param clientOptions The client options.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder clientOptions(ClientOptions clientOptions) {
this.clientOptions = clientOptions;
return this;
}
/**
* Adds a pipeline policy to apply to each request sent.
* <p>
* This method may be called multiple times, each time it is called the policy will be added to the end of added
* policy list. All policies will be added after the retry policy.
*
* @param policy The pipeline policies to added to the policy list.
* @return The updated SearchClientBuilder object.
* @throws NullPointerException If {@code policy} is {@code null}.
*/
public SearchClientBuilder addPolicy(HttpPipelinePolicy policy) {
Objects.requireNonNull(policy, "'policy' cannot be null.");
if (policy.getPipelinePosition() == HttpPipelinePosition.PER_CALL) {
perCallPolicies.add(policy);
} else {
perRetryPolicies.add(policy);
}
return this;
}
/**
* Custom JSON serializer that is used to handle model types that are not contained in the Azure Search Documents
* library.
*
* @param jsonSerializer The serializer to serialize user defined models.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder serializer(JsonSerializer jsonSerializer) {
this.jsonSerializer = jsonSerializer;
return this;
}
/**
* Sets the HTTP client to use for sending requests and receiving responses.
*
* @param client The HTTP client that will handle sending requests and receiving responses.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder httpClient(HttpClient client) {
if (this.httpClient != null && client == null) {
logger.info("HttpClient is being set to 'null' when it was previously configured.");
}
this.httpClient = client;
return this;
}
/**
* Sets the HTTP pipeline to use for the service client.
* <p>
* If {@code pipeline} is set, all other settings are ignored, aside from {@link #endpoint(String) endpoint} and
* {@link #indexName(String) index} when building a {@link SearchClient} or {@link SearchAsyncClient}.
*
* @param httpPipeline The HTTP pipeline to use for sending service requests and receiving responses.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder pipeline(HttpPipeline httpPipeline) {
if (this.httpPipeline != null && httpPipeline == null) {
logger.info("HttpPipeline is being set to 'null' when it was previously configured.");
}
this.httpPipeline = httpPipeline;
return this;
}
/**
* Sets the configuration store that is used during construction of the service client.
* <p>
* The default configuration store is a clone of the {@link Configuration#getGlobalConfiguration() global
* configuration store}, use {@link Configuration#NONE} to bypass using configuration settings during construction.
*
* @param configuration The configuration store that will be used.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder configuration(Configuration configuration) {
this.configuration = configuration;
return this;
}
/**
* Sets the {@link HttpPipelinePolicy} that will attempt to retry requests when needed.
* <p>
* A default retry policy will be supplied if one isn't provided.
*
* @param retryPolicy The {@link RetryPolicy} that will attempt to retry requests when needed.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder retryPolicy(RetryPolicy retryPolicy) {
this.retryPolicy = retryPolicy;
return this;
}
/**
* Sets the {@link SearchServiceVersion} that is used when making API requests.
* <p>
* If a service version is not provided, {@link SearchServiceVersion#getLatest()} will be used as a default. When
* the default is used, updating to a newer client library may implicitly use a newer version of the service.
*
* @param serviceVersion The version of the service to be used when making requests.
* @return The updated SearchClientBuilder object.
*/
public SearchClientBuilder serviceVersion(SearchServiceVersion serviceVersion) {
this.serviceVersion = serviceVersion;
return this;
}
}