org.nuxeo.ecm.restapi.test

Class BaseTest

java.lang.Object

org.nuxeo.ecm.restapi.test.BaseTest

public class BaseTest
extends Object

Since:

5.7.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	BaseTest.RequestType

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.jersey.api.client.Client	client
protected com.fasterxml.jackson.databind.ObjectMapper	mapper
protected com.sun.jersey.api.client.WebResource	service
protected ServletContainerFeature	servletContainerFeature
CoreSession	session

Constructor Summary

Constructors

Constructor and Description
BaseTest()

Method Summary

Modifier and Type	Method and Description
protected void	assertEntityEqualsDoc(InputStream in, DocumentModel doc)
protected void	assertNodeEqualsDoc(com.fasterxml.jackson.databind.JsonNode node, DocumentModel note)
void	doAfter()
void	doBefore()
protected void	fetchInvalidations() Fetch session invalidations.
protected String	getBaseURL()
protected String	getErrorMessage(com.fasterxml.jackson.databind.JsonNode node)
protected List<com.fasterxml.jackson.databind.JsonNode>	getLogEntries(com.fasterxml.jackson.databind.JsonNode node)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, Map<String,String> headers)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, com.sun.jersey.multipart.MultiPart mp)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, com.sun.jersey.multipart.MultiPart mp, Map<String,String> headers)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, String data)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, String data, Map<String,String> headers)
protected CloseableClientResponse	getResponse(BaseTest.RequestType requestType, String path, String data, javax.ws.rs.core.MultivaluedMap<String,String> queryParams, com.sun.jersey.multipart.MultiPart mp, Map<String,String> headers)
protected com.fasterxml.jackson.databind.JsonNode	getResponseAsJson(BaseTest.RequestType responseType, String url)
protected com.fasterxml.jackson.databind.JsonNode	getResponseAsJson(BaseTest.RequestType responseType, String url, javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
protected String	getRestApiUrl()
protected com.sun.jersey.api.client.WebResource	getServiceFor(String username, String password) Returns a WebResource to perform REST API calls with the given credentials.
protected com.sun.jersey.api.client.WebResource	getServiceFor(String resource, String username, String password) Returns a WebResource to perform calls on the given resource with the given credentials.
protected void	setJSONContentTypeIfAbsent(com.sun.jersey.api.client.WebResource.Builder builder, Map<String,String> headers)

Methods inherited from class java.lang.Object

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

Field Detail

servletContainerFeature

@Inject
protected ServletContainerFeature servletContainerFeature

mapper

protected com.fasterxml.jackson.databind.ObjectMapper mapper

client

protected com.sun.jersey.api.client.Client client

service

protected com.sun.jersey.api.client.WebResource service

session

@Inject
public CoreSession session

Constructor Detail

BaseTest

public BaseTest()

Method Detail

doBefore

public void doBefore()
              throws Exception

Throws:

Exception

doAfter

public void doAfter()
             throws Exception

Throws:

Exception

getBaseURL

protected String getBaseURL()

getRestApiUrl

protected String getRestApiUrl()

getServiceFor

protected com.sun.jersey.api.client.WebResource getServiceFor(String username,
                                                              String password)

Returns a WebResource to perform REST API calls with the given credentials.

Since 9.3, uses the Apache HTTP client, more reliable and much more configurable than the one from the JDK.

Since:

5.7.3

getServiceFor

protected com.sun.jersey.api.client.WebResource getServiceFor(String resource,
                                                              String username,
                                                              String password)

Returns a WebResource to perform calls on the given resource with the given credentials.

Uses the Apache HTTP client, more reliable and much more configurable than the one from the JDK.

Since:

9.3

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              Map<String,String> headers)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              com.sun.jersey.multipart.MultiPart mp)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              com.sun.jersey.multipart.MultiPart mp,
                                              Map<String,String> headers)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              String data)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              String data,
                                              Map<String,String> headers)

getResponse

protected CloseableClientResponse getResponse(BaseTest.RequestType requestType,
                                              String path,
                                              String data,
                                              javax.ws.rs.core.MultivaluedMap<String,String> queryParams,
                                              com.sun.jersey.multipart.MultiPart mp,
                                              Map<String,String> headers)

setJSONContentTypeIfAbsent

protected void setJSONContentTypeIfAbsent(com.sun.jersey.api.client.WebResource.Builder builder,
                                          Map<String,String> headers)

Since:

9.3

getResponseAsJson

protected com.fasterxml.jackson.databind.JsonNode getResponseAsJson(BaseTest.RequestType responseType,
                                                                    String url)
                                                             throws IOException,
                                                                    com.fasterxml.jackson.core.JsonProcessingException

Throws:

IOException

com.fasterxml.jackson.core.JsonProcessingException

getResponseAsJson

protected com.fasterxml.jackson.databind.JsonNode getResponseAsJson(BaseTest.RequestType responseType,
                                                                    String url,
                                                                    javax.ws.rs.core.MultivaluedMap<String,String> queryParams)
                                                             throws com.fasterxml.jackson.core.JsonProcessingException,
                                                                    IOException

Parameters:

get -

string -

queryParamsForPage -

Returns:

Throws:

IOException

com.fasterxml.jackson.core.JsonProcessingException

Since:

5.8

fetchInvalidations

protected void fetchInvalidations()

Fetch session invalidations.

Since:

5.9.3

assertNodeEqualsDoc

protected void assertNodeEqualsDoc(com.fasterxml.jackson.databind.JsonNode node,
                                   DocumentModel note)
                            throws Exception

Throws:

Exception

getLogEntries

protected List<com.fasterxml.jackson.databind.JsonNode> getLogEntries(com.fasterxml.jackson.databind.JsonNode node)

getErrorMessage

protected String getErrorMessage(com.fasterxml.jackson.databind.JsonNode node)

Since:

7.1

assertEntityEqualsDoc

protected void assertEntityEqualsDoc(InputStream in,
                                     DocumentModel doc)
                              throws Exception

Throws:

Exception