br.jus.tst.tstunit.jaxrs

Interface MockRequest

All Known Implementing Classes:

ResteasyRequest

public interface MockRequest

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

Since:

29 de mar de 2017

Author:

Thiago Miranda

Method Summary

Modifier and Type	Method and Description
MockRequest	content(byte[] conteudo) Define o conteúdo da requisição como um array de bytes.
MockRequest	content(Object conteudo, JsonToObjectConverter converter) Deprecated. Para gravar um conteúdo em JSON, utilizar content(Object, ObjectToJsonFunction). Este método será removido em versões futuras.
MockRequest	content(Object conteudo, ObjectToJsonFunction converter) Define o conteúdo da requisição como um objeto, utilizando a função informada para transformá-lo em um JSON.
MockRequest	contentType(javax.ws.rs.core.MediaType contentType) Define o tipo de conteúdo sendo enviado na requisição.
MockRequest	contentType(String contentType) Define o tipo de conteúdo sendo enviado na requisição.
MockResponse	executar() Executa a requisição REST.
MockRequest	pathParams(Object... params) Define path params a serem utilizados na substituição de valores do template de URI da requisição.
MockRequest	queryParam(String key, Object... values) Define query params a serem acrescentadas à requisição.
MockRequest	queryParams(Map<String,Object[]> params) Define query params a serem acrescentadas à requisição.

Method Detail

pathParams

MockRequest pathParams(Object... params)

Define path params a serem utilizados na substituição de valores do template de URI da requisição.

Exemplo:

  
  jaxRsEngine.get("meu-recurso/%d/%s").pathParams(1, "fulano");
  // gerará uma URI 'meu-recurso/1/fulano'
 
 

Parameters:

params - os parâmetros

Returns:

this, para chamadas encadeadas de método

queryParam

MockRequest queryParam(String key,
                       Object... values)

Define query params a serem acrescentadas à requisição.

Exemplo:

  
  jaxRsEngine.get("meu-recurso").queryParam("apenasAtivos", Boolean.TRUE);
  // gerará uma URI 'meu-recurso?apenasAtivos=true'
 
  jaxRsEngine.get("meu-recurso").queryParam("id", 1, 2, 3);
  // gerará uma URI 'meu-recurso?id=1&id=2&id=3'
 
 

Parameters:

key - a chave do parâmetro

values - valores do parâmetro

Returns:

this, para chamadas encadeadas de método

queryParams

MockRequest queryParams(Map<String,Object[]> params)

Define query params a serem acrescentadas à requisição.

Exemplo:

  
  jaxRsEngine.get("meu-recurso")
      .queryParams(java.util.Collections.singletonMap("id", new Object[] { 1, 2, 3 }));
  // gerará uma URI 'meu-recurso?id=1&id=2&id=3'
 
 

Parameters:

params - os parâmetros

Returns:

this, para chamadas encadeadas de método

executar

MockResponse executar()

Executa a requisição REST.

Returns:

a resposta da requisição

contentType

MockRequest contentType(String contentType)

Define o tipo de conteúdo sendo enviado na requisição.

Parameters:

contentType - o tipo de conteúdo

Returns:

this, para chamadas encadeadas de método

contentType

MockRequest contentType(javax.ws.rs.core.MediaType contentType)

Define o tipo de conteúdo sendo enviado na requisição.

Parameters:

contentType - o tipo de conteúdo

Returns:

this, para chamadas encadeadas de método

See Also:

MediaType

content

@Deprecated
MockRequest content(Object conteudo,
                                JsonToObjectConverter converter)

Deprecated. Para gravar um conteúdo em JSON, utilizar content(Object, ObjectToJsonFunction). Este método será removido em versões futuras.

Define o conteúdo da requisição como um objeto, utilizando o conversor informado para transformá-lo em um JSON.

Parameters:

conteudo - o objeto a ser gravado na requisição

converter - conversor de objetos Java em JSON

Returns:

this, para chamadas encadeadas de método

content

MockRequest content(Object conteudo,
                    ObjectToJsonFunction converter)

Define o conteúdo da requisição como um objeto, utilizando a função informada para transformá-lo em um JSON.

Parameters:

conteudo - o objeto a ser gravado na requisição

converter - conversor de objetos Java em JSON

Returns:

this, para chamadas encadeadas de método

content

MockRequest content(byte[] conteudo)

Define o conteúdo da requisição como um array de bytes.

Parameters:

conteudo - conteúdo a ser enviado na requisição

Returns:

this, para chamadas encadeadas de método