Package fr.gouv.vitam.common.client

Class VitamRestTestClient

java.lang.Object

fr.gouv.vitam.common.client.DefaultClient

fr.gouv.vitam.common.client.VitamRestTestClient

All Implemented Interfaces:

BasicClient, MockOrRestClient, VitamAutoCloseable, java.lang.AutoCloseable

public class VitamRestTestClient
extends DefaultClient

Vitam Restassured like client for Junit test

Example:

 
   GET http://host:port/service/v1/resource/path1/monid1/path2/monid2
      Header: X-Request-Id = abcd
      Body = Json(body)
      Expected: OK
   int statusCode = testClient.given().accept(MediaType.APPLICATION_JSON_TYPE)
         .addHeader("X-Request-Id", "abcd")
         .addPathParameter("path1", "monid1").addPathParameter("path2", "monid2")
         .body(body, MediaType.APPLICATION_JSON_TYPE)
         .status(Status.OK).get("resource");

   POST http://host:port/service/v1/resource/path1/monid1/path2/monid2
      Header: X-Request-Id = abcd
      Body = Json(body)
      Expected: OK + Body: InputStream
   InputStream stream = testClient.given().accept(MediaType.APPLICATION_OCTET_STREAM_TYPE)
         .addHeader("X-Request-Id", "abcd")
         .addPathParameter("path1", "monid1").addPathParameter("path2", "monid2")
         .body(body, MediaType.APPLICATION_JSON_TYPE)
         .status(Status.OK).get("resource", InputStream.class);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VitamRestTestClient.VitamRestTest	VItam Rest Test: mimic of Restassured.RequestSpecification

Field Summary

Fields inherited from interface fr.gouv.vitam.common.client.BasicClient

STATUS_URL

Constructor Summary

Constructors

Constructor	Description
VitamRestTestClient(VitamClientFactoryInterface<?> factory)	Constructor using given scheme (http) and allowing multipart but no chunk

Method Summary

Modifier and Type	Method	Description
void	checkStatus()	Check the status from the service
void	checkStatus(javax.ws.rs.core.MultivaluedHashMap<java.lang.String,java.lang.Object> headers)	Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate
void	close()	Close the underneath http client
void	consumeAnyEntityAndClose(javax.ws.rs.core.Response response)	Helper when an error occurs on client usage side to consume response however
javax.ws.rs.client.Client	getChunkedClient()
javax.ws.rs.client.Client	getClient()
VitamClientFactory<?>	getClientFactory()
java.lang.String	getResourcePath()	Get the resource path of the server.
java.lang.String	getServiceUrl()	Get the service URL
VitamRestTestClient.VitamRestTest	given()
javax.ws.rs.core.Response	make(VitamRequestBuilder request)
javax.ws.rs.core.Response	makeSpecifyingUrl(VitamRequestBuilder request)
static void	staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)	This method consume everything (in particular InputStream) and close the response.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VitamRestTestClient

public VitamRestTestClient(VitamClientFactoryInterface<?> factory)

Constructor using given scheme (http) and allowing multipart but no chunk

Parameters:

factory - The client factory

Method Detail

given

public VitamRestTestClient.VitamRestTest given()

Returns:

a VitamRestTest using this client

staticConsumeAnyEntityAndClose

public static void staticConsumeAnyEntityAndClose(javax.ws.rs.core.Response response)

This method consume everything (in particular InputStream) and close the response.

Parameters:

response -

consumeAnyEntityAndClose

public final void consumeAnyEntityAndClose(javax.ws.rs.core.Response response)

Description copied from interface: MockOrRestClient

Helper when an error occurs on client usage side to consume response however

Specified by:

consumeAnyEntityAndClose in interface MockOrRestClient

checkStatus

public void checkStatus()
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

checkStatus

public void checkStatus(javax.ws.rs.core.MultivaluedHashMap<java.lang.String,java.lang.Object> headers)
                 throws VitamApplicationServerException

Description copied from interface: MockOrRestClient

Check the status from the service used to passe "X-SSL-CLIENT-CERT" header that contain a pem certificate

Specified by:

checkStatus in interface MockOrRestClient

Throws:

VitamApplicationServerException - if the Server is unavailable

getResourcePath

public java.lang.String getResourcePath()

Description copied from interface: MockOrRestClient

Get the resource path of the server.

Specified by:

getResourcePath in interface MockOrRestClient

Returns:

the resource path as string

getServiceUrl

public java.lang.String getServiceUrl()

Description copied from interface: MockOrRestClient

Get the service URL

Specified by:

getServiceUrl in interface MockOrRestClient

Returns:

the service URL

close

public void close()

Description copied from interface: MockOrRestClient

Close the underneath http client

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface MockOrRestClient

Specified by:

close in interface VitamAutoCloseable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

makeSpecifyingUrl

public javax.ws.rs.core.Response makeSpecifyingUrl(VitamRequestBuilder request)
                                            throws VitamClientInternalException

Throws:

VitamClientInternalException

make

public javax.ws.rs.core.Response make(VitamRequestBuilder request)
                               throws VitamClientInternalException

Throws:

VitamClientInternalException

getClientFactory

public VitamClientFactory<?> getClientFactory()

getClient

public javax.ws.rs.client.Client getClient()

getChunkedClient

public javax.ws.rs.client.Client getChunkedClient()