java.lang.Object
- org.alfresco.utility.dsl.DSLWrapper<RestWrapper>
- - org.alfresco.rest.core.RestWrapper

@Service
@Scope("prototype")
public class RestWrapper
extends org.alfresco.utility.dsl.DSLWrapper<RestWrapper>

Field Summary

Fields
Modifier and Type Field Description

protected RestProperties restProperties
- Fields inherited from class org.alfresco.utility.dsl.DSLWrapper
  contentService, dataContent, jmxBuilder

Constructor Summary

Constructors
Constructor Description

RestWrapper()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RestWrapper`	`assertHeaderValueContains(java.lang.String headerName, java.lang.String expectedHeaderValue)`	Verify response header contains a specific value Example: assertHeaderValueContains("Content-Disposition", "filename=\"myfile.txt\"");
`RestErrorModel`	`assertLastError()`
`RestWrapper`	`assertLastExceptionContains(java.lang.String exception)`
`org.alfresco.utility.model.StatusModel`	`assertLastStatus()`
`RestWrapper`	`assertStatusCodeIs(org.springframework.http.HttpStatus statusCode)`	Assert that a specific status code is returned
`RestWrapper`	`authenticateUser(org.alfresco.utility.model.UserModel userModel)`	Authenticate specific user to Alfresco REST API
`RestWrapper`	`clearBasePath()`	just clear the base path
`void`	`clearParameters()`	Just clear the parameters sent
`void`	`configureAlfrescoEndpoint()`	Adding new method to configure Alfresco Endpoint.
`io.restassured.builder.RequestSpecBuilder`	`configureRequestSpec()`	You can handle the request sent to server by calling this method.
`void`	`configureServerEndpoint()`	Use `setServerURI(String)` and `setServerPort(int)`
`void`	`configureSolrEndPoint()`
`void`	`configureSyncServiceEndPoint()`
`io.restassured.http.ContentType`	`getDefaultContentType()`
`org.alfresco.utility.model.StatusModel`	`getLastStatus()`
`java.lang.String`	`getParameters()`
`io.restassured.http.Headers`	`getResponseHeaders()`
`java.lang.String`	`getStatusCode()`
`void`	`initializeRequestSpecBuilder()`
`RestWrapper`	`noAuthentication()`
`protected io.restassured.specification.RequestSpecification`	`onRequest()`	Request sent to server
`RestResponse`	`onResponse()`
`RestResponse`	`process(RestRequest restRequest)`	Generic REST API call on a `RestRequest`
`void`	`processEmptyModel(RestRequest restRequest)`	Process a response that has no body - basically will need only the status code from it
`RestHtmlResponse`	`processHtmlResponse(RestRequest restRequest)`	Process a response that returns a html
`org.json.JSONObject`	`processJson(RestRequest restRequest)`	Process responses for a single model as `RestSiteModel`
`<T> T`	`processModel(java.lang.Class<T> classz, RestRequest restRequest)`	Process responses for a single model as `RestSiteModel`
`<T> T`	`processModels(java.lang.Class<T> classz, RestRequest restRequest)`	Process responses for a collection of models as `RestSiteModelsCollection`
`<T> T`	`processModelWithoutEntryObject(java.lang.Class<T> classz, RestRequest restRequest)`	Process responses for a single model as `RestSyncSetRequestModel` Notice that `RestSyncSetRequestModel` doesn't have one "entry" field as any other rest request model
`java.util.List<java.lang.Object>`	`processRelationsJson(RestRequest restRequest)`	Process responses for site relations models, such as {@link RestSiteModel, RestSiteContainerModelsCollection, RestSiteMemberModelsCollection}
`java.util.List<java.util.List<java.lang.Object>>`	`processSitesRelationsJson(RestRequest restRequest)`	Process responses for site relations models, such as {@link RestSiteModel, RestSiteContainerModelsCollection, RestSiteMemberModelsCollection}
`RestTextResponse`	`processTextResponse(RestRequest restRequest)`
`protected io.restassured.response.Response`	`sendRequest(RestRequest restRequest)`	Send REST request based on HTTP method
`void`	`setLastError(RestErrorModel errorModel)`
`void`	`setLastStatus(org.alfresco.utility.model.StatusModel lastStatusModel)`	Set the status code for the latest REST call
`void`	`setParameters(java.lang.String parameters)`	Define the entire string of parameters that will be send to request Don't forget to call `getParameters()` in the request to enable this.
`void`	`setResponseHeaders(io.restassured.http.Headers responseHeaders)`
`void`	`setServerPort(int serverPort)`
`void`	`setServerURI(java.lang.String serverURI)`	After configuring `setServerURI(String)` and `setServerPort(int)` call `configureServerEndpoint()`
`void`	`setStatusCode(java.lang.String statusCode)`
`RestWrapper`	`usingContentType(io.restassured.http.ContentType defaultContentType)`
`Tenant`	`usingTenant()`	Provides DSL on creating Tenant users
`<T> void`	`validateJsonModelSchema(java.lang.Class<T> classz, java.lang.Object classzInstance)`	Check that REST response has returned all required fields
`RestWrapper`	`where(java.lang.String whereExpression)`	Construct the Where clause of any REST API call You can use the where parameter to restrict the list in the response to entries of a specific kind.
`AdminConsole`	`withAdminConsole()`
`RestAosAPI`	`withAosAPI()`	Perform AOS browser binding calls ("alfresco/aos") with Rest API
`RestAuthAPI`	`withAuthAPI()`
`RestCmisAPI`	`withCMISApi()`	Perform CMIS browser binding calls ("alfresco/api/-default-/public/cmis/versions/1.1/browser") with Rest API
`RestCoreAPI`	`withCoreAPI()`
`RestDiscoveryAPI`	`withDiscoveryAPI()`
`RestWrapper`	`withParams(java.lang.String... parameters)`	Send key=value parameters All of them will be automatically passed to url.
`RestPrivateAPI`	`withPrivateAPI()`
`SearchAPI`	`withSearchAPI()`
`SearchSQLAPI`	`withSearchSqlAPI()`
`SearchSQLJDBC`	`withSearchSqlViaJDBC()`
`ShardInfoAPI`	`withShardInfoAPI()`
`SolrAdminAPI`	`withSolrAdminAPI()`
`SolrAPI`	`withSolrAPI()`
`RestWorkflowAPI`	`withWorkflowAPI()`

Methods inherited from class org.alfresco.utility.dsl.DSLWrapper
getDataContentService, getTestUser, setTestUser

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - restProperties
```
@Autowired
protected RestProperties restProperties
```
- Constructor Detail
  - RestWrapper
```
public RestWrapper()
```
- Method Detail
  - setServerURI
```
public void setServerURI(java.lang.String serverURI)
```
    After configuring setServerURI(String) and setServerPort(int) call configureServerEndpoint()
    
    Parameters:
    
    serverURI - in format of "http://localhost", without port. Set port via setServerPort(int)
  - setServerPort
```
public void setServerPort(int serverPort)
```
  - setResponseHeaders
```
public void setResponseHeaders(io.restassured.http.Headers responseHeaders)
```
  - getResponseHeaders
```
public io.restassured.http.Headers getResponseHeaders()
```
  - assertHeaderValueContains
```
public RestWrapper assertHeaderValueContains(java.lang.String headerName,
                                             java.lang.String expectedHeaderValue)
```
    Verify response header contains a specific value Example: assertHeaderValueContains("Content-Disposition", "filename=\"myfile.txt\"");
    
    Parameters:
    
    headerName - the header name from response
    
    expectedHeaderValue - the header property value to be checked
    
    Returns:
  - initializeRequestSpecBuilder
```
@PostConstruct
public void initializeRequestSpecBuilder()
```
  - authenticateUser
```
public RestWrapper authenticateUser(org.alfresco.utility.model.UserModel userModel)
```
    Authenticate specific user to Alfresco REST API
    
    Parameters:
    
    userModel -
    
    Returns:
  - noAuthentication
```
public RestWrapper noAuthentication()
```
  - onRequest
```
protected io.restassured.specification.RequestSpecification onRequest()
```
    Request sent to server
  - setLastError
```
public void setLastError(RestErrorModel errorModel)
```
  - assertLastError
```
public RestErrorModel assertLastError()
```
  - assertLastStatus
```
public org.alfresco.utility.model.StatusModel assertLastStatus()
```
  - assertLastExceptionContains
```
public RestWrapper assertLastExceptionContains(java.lang.String exception)
```
  - processModels
```
public <T> T processModels(java.lang.Class<T> classz,
                           RestRequest restRequest)
                    throws EmptyJsonResponseException,
                           JsonToModelConversionException
```
    Process responses for a collection of models as RestSiteModelsCollection
    
    Throws:
    
    JsonToModelConversionException - If the response cannot be converted to the given model.
    
    EmptyJsonResponseException - If there is no response from the server.
  - processModel
```
public <T> T processModel(java.lang.Class<T> classz,
                          RestRequest restRequest)
                   throws EmptyJsonResponseException,
                          JsonToModelConversionException
```
    Process responses for a single model as RestSiteModel
    
    Throws:
    
    JsonToModelConversionException - If the response cannot be converted to the given model.
    
    EmptyJsonResponseException - If there is no response from the server.
  - processJson
```
public org.json.JSONObject processJson(RestRequest restRequest)
                                throws EmptyJsonResponseException,
                                       JsonToModelConversionException
```
    Process responses for a single model as RestSiteModel
    
    Throws:
    
    JsonToModelConversionException - If the response cannot be converted to the given model.
    
    EmptyJsonResponseException - If there is no response from the server.
  - processRelationsJson
```
public java.util.List<java.lang.Object> processRelationsJson(RestRequest restRequest)
```
    Process responses for site relations models, such as {@link RestSiteModel, RestSiteContainerModelsCollection, RestSiteMemberModelsCollection}
  - processSitesRelationsJson
```
public java.util.List<java.util.List<java.lang.Object>> processSitesRelationsJson(RestRequest restRequest)
```
    Process responses for site relations models, such as {@link RestSiteModel, RestSiteContainerModelsCollection, RestSiteMemberModelsCollection}
  - processHtmlResponse
```
public RestHtmlResponse processHtmlResponse(RestRequest restRequest)
                                     throws EmptyJsonResponseException
```
    Process a response that returns a html
    
    Parameters:
    
    restRequest -
    
    Returns:
    
    Throws:
    
    EmptyJsonResponseException - If there is no response from the server.
  - process
```
public RestResponse process(RestRequest restRequest)
```
    Generic REST API call on a RestRequest
    
    Parameters:
    
    restRequest -
    
    Returns:
  - processTextResponse
```
public RestTextResponse processTextResponse(RestRequest restRequest)
```
  - processEmptyModel
```
public void processEmptyModel(RestRequest restRequest)
                       throws EmptyJsonResponseException
```
    Process a response that has no body - basically will need only the status code from it
    
    Parameters:
    
    restRequest -
    
    Throws:
    
    EmptyJsonResponseException
  - getLastStatus
```
public org.alfresco.utility.model.StatusModel getLastStatus()
```
  - setLastStatus
```
public void setLastStatus(org.alfresco.utility.model.StatusModel lastStatusModel)
```
    Set the status code for the latest REST call
    
    Parameters:
    
    lastStatusModel -
  - getStatusCode
```
public java.lang.String getStatusCode()
```
  - setStatusCode
```
public void setStatusCode(java.lang.String statusCode)
```
  - sendRequest
```
protected io.restassured.response.Response sendRequest(RestRequest restRequest)
```
    Send REST request based on HTTP method
    
    Parameters:
    
    restRequest -
    
    Returns:
  - assertStatusCodeIs
```
public RestWrapper assertStatusCodeIs(org.springframework.http.HttpStatus statusCode)
```
    Assert that a specific status code is returned
    
    Parameters:
    
    statusCode -
    
    Returns:
    
    ;
  - validateJsonModelSchema
```
public <T> void validateJsonModelSchema(java.lang.Class<T> classz,
                                        java.lang.Object classzInstance)
                                 throws java.lang.IllegalAccessException,
                                        java.lang.IllegalArgumentException,
                                        java.lang.reflect.InvocationTargetException,
                                        java.lang.InstantiationException
```
    Check that REST response has returned all required fields
    
    Parameters:
    
    classz -
    
    classzInstance -
    
    Throws:
    
    java.lang.IllegalAccessException
    
    java.lang.IllegalArgumentException
    
    java.lang.reflect.InvocationTargetException
    
    java.lang.InstantiationException
  - getParameters
```
public java.lang.String getParameters()
```
    Returns:
    
    parameters that you could pass on the request ?param=value
  - setParameters
```
public void setParameters(java.lang.String parameters)
```
    Define the entire string of parameters that will be send to request Don't forget to call getParameters() in the request to enable this.
    
    Parameters:
    
    parameters -
  - clearParameters
```
public void clearParameters()
```
    Just clear the parameters sent
  - clearBasePath
```
public RestWrapper clearBasePath()
```
    just clear the base path
    
    Returns:
  - withParams
```
public RestWrapper withParams(java.lang.String... parameters)
```
    Send key=value parameters All of them will be automatically passed to url. Example: "maxItems=10000"
    
    Parameters:
    
    parameters -
    
    Returns:
  - withCoreAPI
```
public RestCoreAPI withCoreAPI()
```
    Returns:
    
    RestCoreAPI using the rest Core API as prefix: {@link /alfresco/api/-default-/public/alfresco/versions/1}
  - withWorkflowAPI
```
public RestWorkflowAPI withWorkflowAPI()
```
    Returns:
    
    RestWorkflowAPI using the rest Workflow API with prefix: {@link /alfresco/api/-default-/public/workflow/versions/1 }
  - withAuthAPI
```
public RestAuthAPI withAuthAPI()
```
    Returns:
    
    RestAuthAPI using the rest Auth API with prefix: {@link /alfresco/api/-default-/public/authentication/versions/1 }
  - withSearchAPI
```
public SearchAPI withSearchAPI()
```
  - withSearchSqlAPI
```
public SearchSQLAPI withSearchSqlAPI()
```
  - withSearchSqlViaJDBC
```
public SearchSQLJDBC withSearchSqlViaJDBC()
```
  - withShardInfoAPI
```
public ShardInfoAPI withShardInfoAPI()
```
  - withSolrAPI
```
public SolrAPI withSolrAPI()
```
  - withSolrAdminAPI
```
public SolrAdminAPI withSolrAdminAPI()
```
  - withDiscoveryAPI
```
public RestDiscoveryAPI withDiscoveryAPI()
```
    Returns:
    
    RestDiscoveryAPI using the rest Discovery API as prefix: {@link /alfresco/api/discovery}
  - withAdminConsole
```
public AdminConsole withAdminConsole()
```
    Returns:
    
    AdminConsole using the Admin Console API as prefix: {@link /alfresco/service/api/server}
  - usingTenant
```
public Tenant usingTenant()
```
    Provides DSL on creating Tenant users
    
    Returns:
    
    Tenant
  - where
```
public RestWrapper where(java.lang.String whereExpression)
```
    Construct the Where clause of any REST API call You can use the where parameter to restrict the list in the response to entries of a specific kind. The where parameter takes a value.
  - getDefaultContentType
```
public io.restassured.http.ContentType getDefaultContentType()
```
  - usingContentType
```
public RestWrapper usingContentType(io.restassured.http.ContentType defaultContentType)
```
  - configureRequestSpec
```
public io.restassured.builder.RequestSpecBuilder configureRequestSpec()
```
    You can handle the request sent to server by calling this method. If for example you want to sent multipart form data you can use: restClient.configureRequestSpec() .addMultiPart("filedata", Utility.getResourceTestDataFile("restapi-resource")) .addFormParam("renditions", "doclib") .addFormParam("autoRename", true); restClient.withCoreAPI().usingNode(ContentModel.my()).createNode(); This will create the node using the multipart data defined.
    
    Returns:
  - withCMISApi
```
public RestCmisAPI withCMISApi()
```
    Perform CMIS browser binding calls ("alfresco/api/-default-/public/cmis/versions/1.1/browser") with Rest API
    
    Returns:
    
    RestCmisAPI
  - withAosAPI
```
public RestAosAPI withAosAPI()
```
    Perform AOS browser binding calls ("alfresco/aos") with Rest API
    
    Returns:
    
    RestAosAPI
  - withPrivateAPI
```
public RestPrivateAPI withPrivateAPI()
```
    Returns:
    
    RestPrivateAPI using the rest Private API as prefix: {@link /alfresco/api/-default-/private/alfresco/versions/1}
  - onResponse
```
public RestResponse onResponse()
```
  - processModelWithoutEntryObject
```
public <T> T processModelWithoutEntryObject(java.lang.Class<T> classz,
                                            RestRequest restRequest)
                                     throws EmptyJsonResponseException,
                                            JsonToModelConversionException
```
    Process responses for a single model as RestSyncSetRequestModel Notice that RestSyncSetRequestModel doesn't have one "entry" field as any other rest request model
    
    Throws:
    
    JsonToModelConversionException - If the response cannot be converted to the given model.
    
    EmptyJsonResponseException - If there is no response from the server.
  - configureSyncServiceEndPoint
```
public void configureSyncServiceEndPoint()
```
  - configureSolrEndPoint
```
public void configureSolrEndPoint()
```
  - configureServerEndpoint
```
public void configureServerEndpoint()
```
    Use setServerURI(String) and setServerPort(int)
  - configureAlfrescoEndpoint
```
public void configureAlfrescoEndpoint()
```
    Adding new method to configure Alfresco Endpoint. Reconfiguration is required when restClient is used to executed apis on different : e.g. solr api followed by search api

Class RestWrapper

Field Summary

Fields inherited from class org.alfresco.utility.dsl.DSLWrapper

Constructor Summary

Method Summary

Methods inherited from class org.alfresco.utility.dsl.DSLWrapper

Methods inherited from class java.lang.Object

Field Detail

restProperties

Constructor Detail

RestWrapper

Method Detail

setServerURI

setServerPort

setResponseHeaders

getResponseHeaders

assertHeaderValueContains

initializeRequestSpecBuilder

authenticateUser

noAuthentication

onRequest

setLastError

assertLastError

assertLastStatus

assertLastExceptionContains

processModels

processModel

processJson

processRelationsJson

processSitesRelationsJson

processHtmlResponse

process

processTextResponse

processEmptyModel

getLastStatus

setLastStatus

getStatusCode

setStatusCode

sendRequest

assertStatusCodeIs

validateJsonModelSchema

getParameters

setParameters

clearParameters

clearBasePath

withParams

withCoreAPI

withWorkflowAPI

withAuthAPI

withSearchAPI

withSearchSqlAPI

withSearchSqlViaJDBC

withShardInfoAPI

withSolrAPI

withSolrAdminAPI

withDiscoveryAPI

withAdminConsole

usingTenant

where

getDefaultContentType

usingContentType

configureRequestSpec

withCMISApi

withAosAPI

withPrivateAPI

onResponse

processModelWithoutEntryObject

configureSyncServiceEndPoint

configureSolrEndPoint

configureServerEndpoint

configureAlfrescoEndpoint