ServiceResponseBuilder<T,E> Classe

  • Référence
Paquet:
com.microsoft.bot.restclient
Artefact Maven:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

Paramètres de type

T

Type de retour attendu par l’appelant à partir de la réponse REST.

E

exception à lever en cas d’erreur.

Implémente

ResponseBuilder<T,E>

public final class ServiceResponseBuilder<T,E>
implements ResponseBuilder<T,E>

Le constructeur pour la construction d’un ServiceResponse<T>.

Résumé de la méthode

Modificateur et type Méthode et description
ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Créez un serviceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error, qui n’a pas de corps de réponse.
ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Créez un serviceResponseWithHeaders instance à partir d’une réponse d’appel REST, d’un en-tête au format JSON et d’une erreur possible.
ServiceResponse<T> build(Response<ResponseBody> response)

Générez une instance de serviceResponse à partir d’une réponse d’appel REST et d’une erreur possible.
ServiceResponse<T> buildEmpty(Response<Void> response)

Créez une instance de serviceResponse à partir d’une réponse d’appel REST et d’une erreur possible, qui n’a pas de corps de réponse.
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

Vérifiez si le code d’état retourné est considéré comme un succès pour ce générateur.
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

Inscrivez un mappage à partir d’un code d’état de réponse à un type de destination de réponse.
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

Inscrivez tous les mappages à partir d’un code d’état de réponse dans un type de destination de réponse stocké dans un Map.
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Inscrivez un type de destination pour les erreurs avec les modèles.
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

Spécifie s’il faut lever les réponses 404 à partir d’un appel GET.

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 de la méthode

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Générez une instance ServiceResponseWithHeaders à partir d’une réponse d’appel REST, d’un en-tête au format JSON et d’une erreur possible, qui n’a pas de corps de réponse.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide. Une exception AutoRestException est également levée.

Paramètres:

response
headerType

Exception:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Générez une instance ServiceResponseWithHeaders à partir d’une réponse d’appel REST, d’un en-tête au format JSON et d’une erreur possible.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide et désérialisée dans le type de destination spécifié. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide et désérialisée dans le type d’erreur spécifié s’il en existe un. Une exception AutoRestException est également levée.

Paramètres:

response
headerType

Exception:

java.io.IOException

build

public ServiceResponse build(Response response)

Générez une instance ServiceResponse à partir d’une réponse d’appel REST et d’une erreur possible.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide et désérialisée dans le type de destination spécifié. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide et désérialisée dans le type d’erreur spécifié s’il en existe un. Une exception AutoRestException est également levée.

Paramètres:

response

Exception:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

Générez une instance ServiceResponse à partir d’une réponse d’appel REST et d’une erreur possible, qui n’a pas de corps de réponse.

Si le code d’état de la réponse est inscrit, la réponse est considérée comme valide. Si le code d’état n’est pas inscrit, la réponse est considérée comme non valide. Une exception AutoRestException est également levée.

Paramètres:

response

Exception:

java.io.IOException

exceptionType

public Class exceptionType()

Retours:

type d’exception à lever en cas d’erreur.

isSuccessful

public boolean isSuccessful(int statusCode)

Vérifiez si le code d’état retourné est considéré comme un succès pour ce générateur.

Paramètres:

statusCode - code d’état à vérifier

Retours:

true s’il s’agit d’un succès, faux sinon.

register

public ServiceResponseBuilder register(int statusCode, Type type)

Inscrivez un mappage à partir d’un code d’état de réponse à un type de destination de réponse.

Paramètres:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

Inscrivez tous les mappages à partir d’un code d’état de réponse dans un type de destination de réponse stocké dans un Map.

Paramètres:

responseTypes - mappage des codes d’état de réponse aux types de réponse.

Retours:

la même instance de générateur.

registerError

public ServiceResponseBuilder registerError(Class type)

Inscrivez un type de destination pour les erreurs avec les modèles.

Paramètres:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

Spécifie s’il faut lever les réponses 404 à partir d’un appel GET.

Paramètres:

throwOnGet404 - true s’il faut lever ; false pour simplement retourner null. La valeur par défaut est false.

Retours:

le générateur de réponses lui-même

S’applique à