ResponseBuilder<T,E> Schnittstelle

  • Referenz
Paket:
com.microsoft.bot.restclient.protocol
Maven-Artefakt:
com.microsoft.bot:bot-connector:4.14.3

Typparameter

T

der Textkörpertyp, wenn der Statuscode als erfolgreich betrachtet wird

E

Ausnahmetyp, wenn der Statuscode als Fehler betrachtet wird

public interface ResponseBuilder<T,E>

Definiert eine Schnittstelle, die abhängig vom registrierten Statuscode eine Retrofit 2-Antwort in einen deserialisierten Textkörper oder eine Ausnahme verarbeiten kann.

Methodenzusammenfassung

Modifizierer und Typ Methode und Beschreibung
abstract 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.
abstract 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.
abstract ServiceResponse<T> build(Response<ResponseBody> response)

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

Erstellen Sie eine Dienst-Antwortinstanz aus einer REST-Anrufantwort und einem möglichen Fehler, der keinen Antworttext aufweist.
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

Registrieren Sie eine Zuordnung von einem Antwortstatuscode zu einem Antwortzieltyp.
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registrieren Sie einen Zieltyp für Fehler bei Modellen.

Details zur Methode

<THeader>buildEmptyWithHeaders

public abstract 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 - die Response Instanz aus REST-Aufruf
headerType - der Typ der Kopfzeile

Gibt zurück:

eine ServiceResponseWithHeaders-Instanz vom generischen Typ T

Löst aus:

java.io.IOException - Ausnahmen vom REST-Aufruf

<THeader>buildWithHeaders

public abstract 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 - die Response Instanz aus REST-Aufruf
headerType - der Typ der Kopfzeile

Gibt zurück:

eine ServiceResponseWithHeaders-Instanz vom generischen Typ T

Löst aus:

java.io.IOException - Ausnahmen vom REST-Aufruf

build

public abstract 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 - die Response Instanz aus REST-Aufruf

Gibt zurück:

eine ServiceResponse-Instanz vom generischen Typ T

Löst aus:

java.io.IOException - Ausnahmen vom REST-Aufruf

buildEmpty

public abstract 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 - die Response Instanz aus REST-Aufruf

Gibt zurück:

eine ServiceResponse-Instanz vom generischen Typ T

Löst aus:

java.io.IOException - Ausnahmen vom REST-Aufruf

register

public abstract ResponseBuilder register(int statusCode, Type type)

Registrieren Sie eine Zuordnung von einem Antwortstatuscode zu einem Antwortzieltyp.

Parameter:

statusCode - den Statuscode.
type - der Typ, der deserialisiert werden soll.

Gibt zurück:

dieselbe Generatorinstanz.

registerError

public abstract ResponseBuilder registerError(Class type)

Registrieren Sie einen Zieltyp für Fehler bei Modellen.

Parameter:

type - der Typ, der deserialisiert werden soll.

Gibt zurück:

dieselbe Generatorinstanz.

Gilt für: