ServiceResponseBuilder<T,E> Classe

  • Riferimento
Pacchetto:
com.microsoft.bot.restclient
Artefatto Maven:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.restclient.ServiceResponseBuilder<T,E>

Parametri di tipo

T

Tipo restituito previsto dal chiamante dalla risposta REST.

E

eccezione da generare in caso di errore.

Implementazioni

ResponseBuilder<T,E>

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

Generatore per la creazione di un ServiceResponse<T>.

Riepilogo dei metodi

Modificatore e tipo Metodo e descrizione
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.
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.
ServiceResponse<T> build(Response<ResponseBody> response)

Compilare un'istanza di ServiceResponse da una risposta di chiamata REST e un possibile errore.
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.
java.lang.Class<> exceptionType()
boolean isSuccessful(int statusCode)

Controllare se il codice di stato restituito verrà considerato un esito positivo per questo generatore.
ServiceResponseBuilder<T,E> register(int statusCode, Type type)

Registrare un mapping da un codice di stato della risposta a un tipo di destinazione della risposta.
ServiceResponseBuilder<T,E> registerAll(Map<Integer,Type> responseTypes)

Registrare tutti i mapping da un codice di stato della risposta a un tipo di destinazione della risposta archiviato in un Map.
ServiceResponseBuilder<T,E> registerError(Class<? extends RestException> type)

Registrare un tipo di destinazione per gli errori con i modelli.
ServiceResponseBuilder<T,E> withThrowOnGet404(boolean throwOnGet404)

Specifica se generare risposte 404 da una chiamata GET.

Metodi ereditati da 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

Dettagli metodo

<THeader>buildEmptyWithHeaders

public 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
headerType

Genera un'eccezione:

java.io.IOException

<THeader>buildWithHeaders

public 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
headerType

Genera un'eccezione:

java.io.IOException

build

public 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

Genera un'eccezione:

java.io.IOException

buildEmpty

public 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

Genera un'eccezione:

java.io.IOException

exceptionType

public Class exceptionType()

Restituisce:

tipo di eccezione da generare in caso di errore.

isSuccessful

public boolean isSuccessful(int statusCode)

Controllare se il codice di stato restituito verrà considerato un esito positivo per questo generatore.

Parametri:

statusCode - codice di stato da controllare

Restituisce:

true se è un esito positivo, false in caso contrario.

register

public ServiceResponseBuilder register(int statusCode, Type type)

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

Parametri:

statusCode
type

registerAll

public ServiceResponseBuilder registerAll(Map responseTypes)

Registrare tutti i mapping da un codice di stato della risposta a un tipo di destinazione della risposta archiviato in un Map.

Parametri:

responseTypes - mapping dai codici di stato della risposta ai tipi di risposta.

Restituisce:

stessa istanza del generatore.

registerError

public ServiceResponseBuilder registerError(Class type)

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

Parametri:

type

withThrowOnGet404

public ServiceResponseBuilder withThrowOnGet404(boolean throwOnGet404)

Specifica se generare risposte 404 da una chiamata GET.

Parametri:

throwOnGet404 - true se generare; false per restituire semplicemente null. Il valore predefinito è false.

Restituisce:

Generatore di risposte stesso

Si applica a