ServiceResponseBuilder<T,E> Klasse

  • Referenz
Paket:
com.microsoft.bot.restclient
Maven-Artefakt:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

Typparameter

T

Der Rückgabetyp, den der Aufrufer von der REST-Antwort erwartet.

E

Ausnahme, die beim Fehler ausgelöst werden soll.

Implementiert

ResponseBuilder<T,E->

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

Der Baumeister für den Bau einer ServiceResponse<T>.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Erstellen Sie einen ServiceResponseWithHeaders instance from a REST call response, a header in JSON format, and a possible error, which does not have a response body.
ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Erstellen Sie einen ServiceResponseMitHeaders-Instanz aus einer REST-Aufrufantwort, einem Header im JSON-Format und einem möglichen Fehler.
ServiceResponse<T> build(Response<ResponseBody> response)

Erstellen Sie eine Dienst-Antwortinstanz aus einer REST-Aufrufantwort und einem möglichen Fehler.
ServiceResponse<T> buildEmpty(Response<Void> response)

Erstellen Sie eine Dienst-Antwortinstanz aus einer REST-Anrufantwort und einem möglichen Fehler, der keinen Antworttext aufweist.
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

Überprüfen Sie, ob der zurückgegebene Statuscode als Erfolg für diesen Generator betrachtet wird.
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

Registrieren Sie eine Zuordnung von einem Antwortstatuscode zu einem Antwortzieltyp.
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

Registrieren Sie alle Zuordnungen von einem Antwortstatuscode zu einem in einem Mapgespeicherten Antwortzieltyp.
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registrieren Sie einen Zieltyp für Fehler bei Modellen.
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

Gibt an, ob 404 Antworten von einem GET-Aufruf ausgelöst werden sollen.

Geerbte Methoden von 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

Details zur Methode

<THeader>buildEmptyWithHeaders

public ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Erstellen Sie eine ServiceResponseWithHeaders-Instanz aus einer REST-Aufrufantwort, einem Header im JSON-Format und einem möglichen Fehler, der keinen Antworttext aufweist.

Wenn der Statuscode in der Antwort registriert ist, wird die Antwort als gültig betrachtet. Wenn der Statuscode nicht registriert ist, wird die Antwort als ungültig angesehen. Eine AutoRestException wird ebenfalls ausgelöst.

Parameter:

response
headerType

Löst aus:

java.io.IOException

<THeader>buildWithHeaders

public ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Erstellen Sie eine ServiceResponseWithHeaders-Instanz aus einer REST-Aufrufantwort, einem Header im JSON-Format und einem möglichen Fehler.

Wenn der Statuscode in der Antwort registriert ist, wird die Antwort als gültig betrachtet und in den angegebenen Zieltyp deserialisiert. Wenn der Statuscode nicht registriert ist, wird die Antwort als ungültig betrachtet und in den angegebenen Fehlertyp deserialisiert, falls vorhanden. Eine AutoRestException wird ebenfalls ausgelöst.

Parameter:

response
headerType

Löst aus:

java.io.IOException

build

public ServiceResponse build(Response response)

Erstellen Sie eine ServiceResponse-Instanz aus einer REST-Aufrufantwort und einem möglichen Fehler.

Wenn der Statuscode in der Antwort registriert ist, wird die Antwort als gültig betrachtet und in den angegebenen Zieltyp deserialisiert. Wenn der Statuscode nicht registriert ist, wird die Antwort als ungültig betrachtet und in den angegebenen Fehlertyp deserialisiert, falls vorhanden. Eine AutoRestException wird ebenfalls ausgelöst.

Parameter:

response

Löst aus:

java.io.IOException

buildEmpty

public ServiceResponse buildEmpty(Response response)

Erstellen Sie eine ServiceResponse-Instanz aus einer REST-Aufrufantwort und einem möglichen Fehler, der keinen Antworttext aufweist.

Wenn der Statuscode in der Antwort registriert ist, wird die Antwort als gültig betrachtet. Wenn der Statuscode nicht registriert ist, wird die Antwort als ungültig angesehen. Eine AutoRestException wird ebenfalls ausgelöst.

Parameter:

response

Löst aus:

java.io.IOException

exceptionType

public Class exceptionType()

Gibt zurück:

Der Ausnahmetyp, der im Falle eines Fehlers ausgelöst werden soll.

isSuccessful

public boolean isSuccessful(int statusCode)

Überprüfen Sie, ob der zurückgegebene Statuscode als Erfolg für diesen Generator betrachtet wird.

Parameter:

statusCode - der zu überprüfende Statuscode

Gibt zurück:

"true", wenn es ein Erfolg ist, andernfalls "false".

register

public ServiceResponseBuilder register(int statusCode, Type type)

Registrieren Sie eine Zuordnung von einem Antwortstatuscode zu einem Antwortzieltyp.

Parameter:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

Registrieren Sie alle Zuordnungen von einem Antwortstatuscode zu einem in einem Mapgespeicherten Antwortzieltyp.

Parameter:

responseTypes - die Zuordnung von Antwortstatuscodes zu Antworttypen.

Gibt zurück:

dieselbe Generatorinstanz.

registerError

public ServiceResponseBuilder registerError(Class type)

Registrieren Sie einen Zieltyp für Fehler bei Modellen.

Parameter:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

Gibt an, ob 404 Antworten von einem GET-Aufruf ausgelöst werden sollen.

Parameter:

throwOnGet404 - true, wenn es ausgelöst werden soll; false, um einfach NULL zurückzugeben. Der Standardwert ist "false".

Gibt zurück:

der Antwort-Generator selbst

Gilt für: