br.jus.tst.tstunit.jaxrs

Interface MockResponse

All Known Implementing Classes:

ResteasyResponse

public interface MockResponse

Representa uma simulação de resposta de um serviço JAX-RS.

Since:

29 de mar de 2017

Author:

Thiago Miranda

Method Summary

Modifier and Type	Method and Description
MockResponse	deveRetornarHeader(String headerName) Asserção de que a resposta possua o cabeçalho informado.
MockResponse	deveRetornarHeader(String headerName, Object headerValue) Asserção de que a resposta deve conter um header com o nome e valor informados.
MockResponse	deveRetornarObjetoDoTipo(Class<?> tipo) Deprecated. Para obter a resposta em JSON, utilizar getObjetoRespostaUsando(JsonToObjectFunction). Este método será removido em versões futuras.
MockResponse	deveRetornarObjetoDoTipo(TypeReference<?> typeReference) Deprecated. Para obter a resposta em JSON, utilizar getObjetoRespostaUsando(JsonToObjectFunction). Este método será removido em versões futuras.
MockResponse	deveRetornarRespostaDoTipo(javax.ws.rs.core.MediaType contentType) Asserção de que a resposta retorne conteúdo do tipo informado.
default MockResponse	deveRetornarRespostaDoTipo(String contentType) Asserção de que a resposta retorne conteúdo do tipo informado.
MockResponse	deveRetornarStatus(javax.ws.rs.core.Response.Status status) Asserção de que o código HTTP da resposta seja igual ao informado.
MockResponse	deveRetornarStatusOk() Asserção de que o código HTTP da resposta seja HttpStatus.SC_OK.
InputStream	getConteudoResposta() Obtém o conteúdo da resposta como um stream
String	getConteudoRespostaComoString() Obtém o conteúdo da resposta no formato de uma String.
Object	getImplementacaoSubjacente() Fornece acesso à API sendo utilizada para simular os acessos HTTP.
<T> T	getObjetoRespostaUsando(JsonToObjectConverter converter) Deprecated. Para obter a resposta em JSON, utilizar getObjetoRespostaUsando(JsonToObjectFunction). Este método será removido em versões futuras.
default <T> T	getObjetoRespostaUsando(JsonToObjectFunction<T> conversor) Obtém um POJO representando o JSON retornado como resposta.
MockResponse	naoDeveRetornarConteudo() Asserção de que a resposta não possua corpo.

Method Detail

deveRetornarStatusOk

MockResponse deveRetornarStatusOk()

Asserção de que o código HTTP da resposta seja HttpStatus.SC_OK.

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarStatus

MockResponse deveRetornarStatus(javax.ws.rs.core.Response.Status status)

Asserção de que o código HTTP da resposta seja igual ao informado.

Parameters:

status - status HTTP esperado

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarObjetoDoTipo

@Deprecated
MockResponse deveRetornarObjetoDoTipo(Class<?> tipo)

Deprecated. Para obter a resposta em JSON, utilizar getObjetoRespostaUsando(JsonToObjectFunction). Este método será removido em versões futuras.

Asserção de que a resposta retorne uma representação de objeto do tipo informado.

Parameters:

tipo - tipo de objeto esperado

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarObjetoDoTipo

@Deprecated
MockResponse deveRetornarObjetoDoTipo(TypeReference<?> typeReference)

Deprecated. Para obter a resposta em JSON, utilizar getObjetoRespostaUsando(JsonToObjectFunction). Este método será removido em versões futuras.

Asserção de que a resposta retorne uma representação de objeto do tipo informado.

Parameters:

typeReference - tipo de objeto esperado

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarRespostaDoTipo

default MockResponse deveRetornarRespostaDoTipo(String contentType)

Asserção de que a resposta retorne conteúdo do tipo informado.

Parameters:

contentType - tipo de conteúdo esperado

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarRespostaDoTipo

MockResponse deveRetornarRespostaDoTipo(javax.ws.rs.core.MediaType contentType)

Asserção de que a resposta retorne conteúdo do tipo informado.

Parameters:

contentType - tipo de conteúdo esperado

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

naoDeveRetornarConteudo

MockResponse naoDeveRetornarConteudo()

Asserção de que a resposta não possua corpo.

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarHeader

MockResponse deveRetornarHeader(String headerName)

Asserção de que a resposta possua o cabeçalho informado.

Parameters:

headerName - nome do cabeçalho HTTP esperado

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

deveRetornarHeader

MockResponse deveRetornarHeader(String headerName,
                                Object headerValue)

Asserção de que a resposta deve conter um header com o nome e valor informados. Observar o tipo do valor do header, que também será checado (por exemplo, uma URI "/teste/1" será considerada diferente de uma String "/teste/1").

Parameters:

headerName - nome do cabeçalho HTTP esperado

headerValue - valor esperado para o cabeçalho HTTP

Returns:

this, para chamadas encadeadas de método

Throws:

AssertionError - caso a asserção falhe

getObjetoRespostaUsando

@Deprecated
<T> T getObjetoRespostaUsando(JsonToObjectConverter converter)

Deprecated. Para obter a resposta em JSON, utilizar getObjetoRespostaUsando(JsonToObjectFunction). Este método será removido em versões futuras.

Obtém um POJO representando o JSON retornado como resposta.

Type Parameters:

T - o tipo de objeto esperado

Parameters:

converter - instância a ser utilizada para converter a resposta JSON em um POJO.

Returns:

a instância criada a partir do JSON de resposta

Throws:

JaxRsException - caso ocorra algum erro ao converter o conteúdo da resposta

getObjetoRespostaUsando

default <T> T getObjetoRespostaUsando(JsonToObjectFunction<T> conversor)

Obtém um POJO representando o JSON retornado como resposta.

Exemplo de utilização:

  
  MockResponse response = ...;
  Objeto obj = response.getObjetoRespostaUsando((stream) -> meuConversor.readObject(stream));
 
 

Type Parameters:

T - o tipo de objeto esperado

Parameters:

conversor - função a a ser utilizada para converter a resposta JSON em um POJO.

Returns:

a instância criada a partir do JSON de resposta

Throws:

NullPointerException - caso seja informado null

JaxRsException - caso ocorra algum erro ao converter o conteúdo da resposta

getConteudoResposta

InputStream getConteudoResposta()

Obtém o conteúdo da resposta como um stream

Returns:

stream de leitura do conteúdo da resposta

getConteudoRespostaComoString

String getConteudoRespostaComoString()

Obtém o conteúdo da resposta no formato de uma String.

Returns:

o conteúdo da resposta como String

Throws:

JaxRsException - caso ocorra algum erro ao converter o conteúdo da resposta em String

getImplementacaoSubjacente

Object getImplementacaoSubjacente()

Fornece acesso à API sendo utilizada para simular os acessos HTTP.

Returns:

a instância de acesso à API