RestClient.Builder Classe

  • java.lang.Object
    • com.microsoft.bot.restclient.RestClient.Builder

public static class RestClient.Builder

Classe builder per la creazione di un client REST.

Riepilogo dei costruttori

Costruttore Descrizione
Builder()

Crea un'istanza del generatore con un URL di base per il servizio.

Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

Crea un'istanza del generatore con un URL di base e 2 generatori personalizzati.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
RestClient build()

Creare un client restcon tutte le configurazioni correnti.

Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Imposta se usare il pool di thread in Okclient Http o Rxutilità di pianificazione Java.

Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Imposta l'URL di base con il valore predefinito di Environment.

Builder withBaseUrl(String baseUrl)

Imposta l'URL di base dinamico.

Builder withCallbackExecutor(Executor executor)

Imposta l'executor per l'esecuzione dei callback asincroni.

Builder withConnectionPool(ConnectionPool connectionPool)

Imposta il pool di connessioni per il client Http.

Builder withConnectionTimeout(long timeout, TimeUnit unit)

Impostare il timeout della connessione nel client HTTP.

Builder withCredentials(ServiceClientCredentials credentials)

Imposta le credenziali.

Builder withDispatcher(Dispatcher dispatcher)

Imposta il dispatcher usato in Okclient Http.

Builder withInterceptor(Interceptor interceptor)

Aggiungere un intercettore alla pipeline client Http.

Builder withLogLevel(LogLevel logLevel)

Imposta il livello di log HTTP.

Builder withMaxIdleConnections(int maxIdleConnections)

Deprecato

Impostare le connessioni inattive massime per il client HTTP.

Builder withNetworkInterceptor(Interceptor networkInterceptor)

Aggiungere un intercettore al livello di rete della pipeline client Http.

Builder withProxy(Proxy proxy)

Imposta il proxy per il client HTTP.

Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Imposta l'autenticatore proxy per il client HTTP.

Builder withReadTimeout(long timeout, TimeUnit unit)

Impostare il timeout di lettura nel client HTTP.

Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Imposta la factory del generatore di risposte.

Builder withRetryStrategy(RetryStrategy strategy)

Aggiunge una strategia di ripetizione dei tentativi al client.

Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

Imposta l'adattatore di serializzazione.

Builder withUserAgent(String userAgent)

Imposta l'intestazione dell'agente utente.

Metodi ereditati da java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Dettagli costruttore

Builder

public Builder()

Crea un'istanza del generatore con un URL di base per il servizio.

Builder

public Builder(OkHttpClient.Builder httpClientBuilder, Retrofit.Builder retrofitBuilder)

Crea un'istanza del generatore con un URL di base e 2 generatori personalizzati.

Parametri:

httpClientBuilder - generatore per compilare un OkHttpClient.
retrofitBuilder - generatore per compilare un Retrofit.

Dettagli metodo

build

public RestClient build()

Creare un restClient con tutte le configurazioni correnti.

Restituisce:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Imposta un valore che indica se utilizzare il pool di thread nelle utilità di pianificazione okHttp o RxJava. Se impostato su true, verrà usato il pool di thread nel client OkHttp. Il valore predefinito è false.

Parametri:

useHttpClientThreadPool - se usare il pool di thread nel client Okhttp. Il valore predefinito è false.

Restituisce:

il generatore stesso per il concatenamento

withBaseUrl

public RestClient.Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Imposta l'URL di base con il valore predefinito di Environment.

Parametri:

environment - ambiente da usare
endpoint - l'endpoint dell'ambiente a cui l'applicazione accede

Restituisce:

il generatore stesso per il concatenamento

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

Imposta l'URL di base dinamico.

Parametri:

baseUrl - URL di base da usare.

Restituisce:

il generatore stesso per il concatenamento.

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

Imposta l'executor per l'esecuzione dei callback asincroni.

Parametri:

executor - executor per eseguire i callback.

Restituisce:

il generatore stesso per il concatenamento

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

Imposta il pool di connessioni per il client Http.

Parametri:

connectionPool - pool di connessioni OkHttp 3 da usare

Restituisce:

il generatore stesso per il concatenamento

withConnectionTimeout

public RestClient.Builder withConnectionTimeout(long timeout, TimeUnit unit)

Impostare il timeout della connessione nel client HTTP. Il valore predefinito è 10 secondi.

Parametri:

timeout - valore numerico di timeout
unit - unità temporale per il valore numerico

Restituisce:

il generatore stesso per il concatenamento

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

Imposta le credenziali.

Parametri:

credentials - oggetto credentials.

Restituisce:

il generatore stesso per il concatenamento.

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

Imposta il dispatcher utilizzato nel client OkHttp. Questo è anche il percorso in cui impostare il pool di thread per l'esecuzione di richieste HTTP.

Parametri:

dispatcher - dispatcher da usare

Restituisce:

il generatore stesso per il concatenamento

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

Aggiungere un intercettore alla pipeline client Http.

Parametri:

interceptor - intercettore da aggiungere.

Restituisce:

il generatore stesso per il concatenamento.

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

Imposta il livello di log HTTP.

Parametri:

logLevel - enumerazione LogLevel.

Restituisce:

il generatore stesso per il concatenamento.

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

Deprecato

Impostare le connessioni inattive massime per il client HTTP. Il valore predefinito è 5.

Parametri:

maxIdleConnections - numero massimo di connessioni inattive

Restituisce:

il generatore stesso per il concatenamento

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

Aggiungere un intercettore al livello di rete della pipeline client Http.

Parametri:

networkInterceptor - intercettore da aggiungere.

Restituisce:

il generatore stesso per il concatenamento.

withProxy

public RestClient.Builder withProxy(Proxy proxy)

Imposta il proxy per il client HTTP.

Parametri:

proxy - proxy da usare

Restituisce:

il generatore stesso per il concatenamento

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Imposta l'autenticatore proxy per il client HTTP.

Parametri:

proxyAuthenticator - autenticatore proxy da usare

Restituisce:

il generatore stesso per il concatenamento

withReadTimeout

public RestClient.Builder withReadTimeout(long timeout, TimeUnit unit)

Impostare il timeout di lettura nel client HTTP. Il valore predefinito è 10 secondi.

Parametri:

timeout - valore numerico di timeout
unit - unità temporale per il valore numerico

Restituisce:

il generatore stesso per il concatenamento

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Imposta la factory del generatore di risposte.

Parametri:

responseBuilderFactory - factory del generatore di risposte

Restituisce:

il generatore stesso per il concatenamento

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

Aggiunge una strategia di ripetizione dei tentativi al client.

Parametri:

strategy - strategia di ripetizione dei tentativi da aggiungere

Restituisce:

il generatore stesso per il concatenamento

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

Imposta l'adattatore di serializzazione.

Parametri:

serializerAdapter - adattatore a un serializzatore

Restituisce:

il generatore stesso per il concatenamento

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

Imposta l'intestazione dell'agente utente.

Parametri:

userAgent - intestazione dell'agente utente.

Restituisce:

il generatore stesso per il concatenamento.

Si applica a