ResponseBuilder<T,E> Interfaccia

  • Riferimento
Pacchetto:
com.microsoft.bot.restclient.protocol
Artefatto Maven:
com.microsoft.bot:bot-connector:4.14.3

Parametri di tipo

T

tipo di corpo se il codice di stato è considerato riuscito

E

tipo di eccezione se il codice di stato è considerato un errore

public interface ResponseBuilder<T,E>

Definisce un'interfaccia in grado di elaborare una risposta Dell'Aggiornamento 2 in un corpo deserializzato o in un'eccezione, a seconda del codice di stato registrato.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildEmptyWithHeaders(Response<Void> response, Class<THeader> headerType)

Compilare un'istanza di ServiceResponseWithHeaders da una risposta di chiamata REST, un'intestazione in formato JSON e un possibile errore, che non ha un corpo della risposta.
abstract ServiceResponseWithHeaders<T,THeader> <THeader>buildWithHeaders(Response<ResponseBody> response, Class<THeader> headerType)

Compilare un'istanza di ServiceResponseWithHeaders da una risposta di chiamata REST, un'intestazione in formato JSON e un possibile errore.
abstract ServiceResponse<T> build(Response<ResponseBody> response)

Compilare un'istanza di ServiceResponse da una risposta di chiamata REST e un possibile errore.
abstract ServiceResponse<T> buildEmpty(Response<Void> response)

Compilare un'istanza di ServiceResponse da una risposta di chiamata REST e un possibile errore, che non ha un corpo della risposta.
abstract ResponseBuilder<T,E> register(int statusCode, Type type)

Registrare un mapping da un codice di stato della risposta a un tipo di destinazione della risposta.
abstract ResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registrare un tipo di destinazione per gli errori con i modelli.

Dettagli metodo

<THeader>buildEmptyWithHeaders

public abstract ServiceResponseWithHeaders buildEmptyWithHeaders(Response response, Class headerType)

Compilare un'istanza serviceResponseWithHeaders da una risposta di chiamata REST, un'intestazione in formato JSON e un possibile errore, che non ha un corpo della risposta.

Se il codice di stato nella risposta viene registrato, la risposta verrà considerata valida. Se il codice di stato non è registrato, la risposta verrà considerata non valida. Viene generata anche un'eccezione AutoRestException.

Parametri:

response - l'istanza Response dalla chiamata REST
headerType - tipo dell'intestazione

Restituisce:

un'istanza ServiceResponseWithHeaders di tipo generico T

Genera un'eccezione:

java.io.IOException - eccezioni dalla chiamata REST

<THeader>buildWithHeaders

public abstract ServiceResponseWithHeaders buildWithHeaders(Response response, Class headerType)

Compilare un'istanza serviceResponseWithHeaders da una risposta di chiamata REST, un'intestazione in formato JSON e un possibile errore.

Se il codice di stato nella risposta viene registrato, la risposta verrà considerata valida e deserializzata nel tipo di destinazione specificato. Se il codice di stato non è registrato, la risposta verrà considerata non valida e deserializzata nel tipo di errore specificato, se presente. Viene generata anche un'eccezione AutoRestException.

Parametri:

response - l'istanza Response dalla chiamata REST
headerType - tipo dell'intestazione

Restituisce:

un'istanza ServiceResponseWithHeaders di tipo generico T

Genera un'eccezione:

java.io.IOException - eccezioni dalla chiamata REST

build

public abstract ServiceResponse build(Response response)

Compilare un'istanza serviceResponse da una risposta di chiamata REST e un possibile errore.

Se il codice di stato nella risposta viene registrato, la risposta verrà considerata valida e deserializzata nel tipo di destinazione specificato. Se il codice di stato non è registrato, la risposta verrà considerata non valida e deserializzata nel tipo di errore specificato, se presente. Viene generata anche un'eccezione AutoRestException.

Parametri:

response - l'istanza Response dalla chiamata REST

Restituisce:

un'istanza serviceResponse di tipo generico T

Genera un'eccezione:

java.io.IOException - eccezioni dalla chiamata REST

buildEmpty

public abstract ServiceResponse buildEmpty(Response response)

Compilare un'istanza di ServiceResponse da una risposta di chiamata REST e un possibile errore, che non ha un corpo della risposta.

Se il codice di stato nella risposta viene registrato, la risposta verrà considerata valida. Se il codice di stato non è registrato, la risposta verrà considerata non valida. Viene generata anche un'eccezione AutoRestException.

Parametri:

response - l'istanza Response dalla chiamata REST

Restituisce:

un'istanza serviceResponse di tipo generico T

Genera un'eccezione:

java.io.IOException - eccezioni dalla chiamata REST

register

public abstract ResponseBuilder register(int statusCode, Type type)

Registrare un mapping da un codice di stato della risposta a un tipo di destinazione della risposta.

Parametri:

statusCode - codice di stato.
type - tipo da deserializzare.

Restituisce:

stessa istanza del generatore.

registerError

public abstract ResponseBuilder registerError(Class type)

Registrare un tipo di destinazione per gli errori con i modelli.

Parametri:

type - tipo da deserializzare.

Restituisce:

stessa istanza del generatore.

Si applica a