RestClient.Builder Classe

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

public static class RestClient.Builder

Classe builder pour la création d’un client REST.

Récapitulatif du constructeur

Constructeur Description
Builder()

Crée une instance du générateur avec une URL de base vers le service.

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

Crée une instance du générateur avec une URL de base et 2 générateurs personnalisés.

Résumé de la méthode

Modificateur et type Méthode et description
RestClient build()

Générez un client Restavec toutes les configurations actuelles.

Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Définit s’il faut utiliser le pool de threads dans Okclient Http ou Rxplanificateurs Java.

Builder withBaseUrl(Environment environment, Environment.Endpoint endpoint)

Définit l’URL de base avec la valeur par défaut de l’environnement.

Builder withBaseUrl(String baseUrl)

Définit l’URL de base dynamique.

Builder withCallbackExecutor(Executor executor)

Définit l’exécuteur pour les rappels asynchrones à exécuter.

Builder withConnectionPool(ConnectionPool connectionPool)

Définit le pool de connexions pour le client Http.

Builder withConnectionTimeout(long timeout, TimeUnit unit)

Définissez le délai d’expiration de la connexion sur le client HTTP.

Builder withCredentials(ServiceClientCredentials credentials)

Définit les informations d’identification.

Builder withDispatcher(Dispatcher dispatcher)

Définit le répartiteur utilisé dans Okclient Http.

Builder withInterceptor(Interceptor interceptor)

Ajoutez un intercepteur au pipeline client Http.

Builder withLogLevel(LogLevel logLevel)

Définit le niveau du journal HTTP.

Builder withMaxIdleConnections(int maxIdleConnections)

Déprécié

Définissez les connexions inactives maximales pour le client HTTP.

Builder withNetworkInterceptor(Interceptor networkInterceptor)

Ajoutez un intercepteur à la couche réseau du pipeline client Http.

Builder withProxy(Proxy proxy)

Définit le proxy pour le client HTTP.

Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Définit l’authentificateur proxy pour le client HTTP.

Builder withReadTimeout(long timeout, TimeUnit unit)

Définissez le délai d’attente de lecture sur le client HTTP.

Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Définit la fabrique du générateur de réponses.

Builder withRetryStrategy(RetryStrategy strategy)

Ajoute une stratégie de nouvelle tentative au client.

Builder withSerializerAdapter(SerializerAdapter<?> serializerAdapter)

Définit l’adaptateur de sérialisation.

Builder withUserAgent(String userAgent)

Définit l’en-tête de l’agent utilisateur.

Méthodes héritées de 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

Détails du constructeur

Builder

public Builder()

Crée une instance du générateur avec une URL de base vers le service.

Builder

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

Crée une instance du générateur avec une URL de base et 2 générateurs personnalisés.

Paramètres:

httpClientBuilder - le générateur pour générer un OkHttpClient.
retrofitBuilder - le générateur pour générer un Retrofit.

Détails de la méthode

build

public RestClient build()

Générez un RestClient avec toutes les configurations actuelles.

Retours:

useHttpClientThreadPool

public RestClient.Builder useHttpClientThreadPool(boolean useHttpClientThreadPool)

Définit s’il faut utiliser le pool de threads dans les planificateurs OkHttp client ou RxJava. Si la valeur est true, le pool de threads dans le client OkHttp est utilisé. La valeur par défaut est false.

Paramètres:

useHttpClientThreadPool - indique s’il faut utiliser le pool de threads dans le client Okhttp. La valeur par défaut est false.

Retours:

le constructeur lui-même pour le chaînage

withBaseUrl

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

Définit l’URL de base avec la valeur par défaut de l’environnement.

Paramètres:

environment - l’environnement à utiliser
endpoint - le point de terminaison de l’environnement que l’application accède

Retours:

le constructeur lui-même pour le chaînage

withBaseUrl

public RestClient.Builder withBaseUrl(String baseUrl)

Définit l’URL de base dynamique.

Paramètres:

baseUrl - URL de base à utiliser.

Retours:

le constructeur lui-même pour le chaînage.

withCallbackExecutor

public RestClient.Builder withCallbackExecutor(Executor executor)

Définit l’exécuteur pour les rappels asynchrones à exécuter.

Paramètres:

executor - exécuteur pour exécuter les rappels.

Retours:

le constructeur lui-même pour le chaînage

withConnectionPool

public RestClient.Builder withConnectionPool(ConnectionPool connectionPool)

Définit le pool de connexions pour le client Http.

Paramètres:

connectionPool - le pool de connexions OkHttp 3 à utiliser

Retours:

le constructeur lui-même pour le chaînage

withConnectionTimeout

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

Définissez le délai d’expiration de la connexion sur le client HTTP. La valeur par défaut est de 10 secondes.

Paramètres:

timeout - valeur numérique de délai d’expiration
unit - unité de temps pour la valeur numérique

Retours:

le constructeur lui-même pour le chaînage

withCredentials

public RestClient.Builder withCredentials(ServiceClientCredentials credentials)

Définit les informations d’identification.

Paramètres:

credentials - l’objet d’informations d’identification.

Retours:

le constructeur lui-même pour le chaînage.

withDispatcher

public RestClient.Builder withDispatcher(Dispatcher dispatcher)

Définit le répartiteur utilisé dans le client OkHttp. Il s’agit également de l’emplacement où définir le pool de threads pour l’exécution de requêtes HTTP.

Paramètres:

dispatcher - répartiteur à utiliser

Retours:

le constructeur lui-même pour le chaînage

withInterceptor

public RestClient.Builder withInterceptor(Interceptor interceptor)

Ajoutez un intercepteur au pipeline client Http.

Paramètres:

interceptor - intercepteur à ajouter.

Retours:

le constructeur lui-même pour le chaînage.

withLogLevel

public RestClient.Builder withLogLevel(LogLevel logLevel)

Définit le niveau du journal HTTP.

Paramètres:

logLevel - énumération LogLevel.

Retours:

le constructeur lui-même pour le chaînage.

withMaxIdleConnections


public RestClient.Builder withMaxIdleConnections(int maxIdleConnections)

Déprécié

Définissez les connexions inactives maximales pour le client HTTP. La valeur par défaut est 5.

Paramètres:

maxIdleConnections - les connexions inactives maximales

Retours:

le constructeur lui-même pour le chaînage

withNetworkInterceptor

public RestClient.Builder withNetworkInterceptor(Interceptor networkInterceptor)

Ajoutez un intercepteur à la couche réseau du pipeline client Http.

Paramètres:

networkInterceptor - intercepteur à ajouter.

Retours:

le constructeur lui-même pour le chaînage.

withProxy

public RestClient.Builder withProxy(Proxy proxy)

Définit le proxy pour le client HTTP.

Paramètres:

proxy - proxy à utiliser

Retours:

le constructeur lui-même pour le chaînage

withProxyAuthenticator

public RestClient.Builder withProxyAuthenticator(Authenticator proxyAuthenticator)

Définit l’authentificateur proxy pour le client HTTP.

Paramètres:

proxyAuthenticator - l’authentificateur proxy à utiliser

Retours:

le constructeur lui-même pour le chaînage

withReadTimeout

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

Définissez le délai d’attente de lecture sur le client HTTP. La valeur par défaut est de 10 secondes.

Paramètres:

timeout - valeur numérique de délai d’expiration
unit - unité de temps pour la valeur numérique

Retours:

le constructeur lui-même pour le chaînage

withResponseBuilderFactory

public RestClient.Builder withResponseBuilderFactory(ResponseBuilder.Factory responseBuilderFactory)

Définit la fabrique du générateur de réponses.

Paramètres:

responseBuilderFactory - fabrique du générateur de réponses

Retours:

le constructeur lui-même pour le chaînage

withRetryStrategy

public RestClient.Builder withRetryStrategy(RetryStrategy strategy)

Ajoute une stratégie de nouvelle tentative au client.

Paramètres:

strategy - la stratégie de nouvelle tentative à ajouter

Retours:

le constructeur lui-même pour le chaînage

withSerializerAdapter

public RestClient.Builder withSerializerAdapter(SerializerAdapter serializerAdapter)

Définit l’adaptateur de sérialisation.

Paramètres:

serializerAdapter - adaptateur à un sérialiseur

Retours:

le constructeur lui-même pour le chaînage

withUserAgent

public RestClient.Builder withUserAgent(String userAgent)

Définit l’en-tête de l’agent utilisateur.

Paramètres:

userAgent - en-tête de l’agent utilisateur.

Retours:

le constructeur lui-même pour le chaînage.

S’applique à