com.sap.cds.services.utils.rest.client

Class JsonRestClient

java.lang.Object

com.sap.cds.services.utils.rest.client.JsonRestClient

public class JsonRestClient
extends Object

Implementation of a simple JSON REST client.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.fasterxml.jackson.databind.ObjectMapper	mapper

Constructor Summary

Constructors

Constructor and Description
JsonRestClient(JsonRestClientConfiguration cfg) Creates the client and performs the client authentication.
JsonRestClient(JsonRestClientConfiguration cfg, List<org.apache.http.Header> additionalHeaders) Creates the client and performs the client authentication.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	deleteRequest(String path) Performs a HTTP DELETE request and returns the JSON response.
com.fasterxml.jackson.databind.JsonNode	getJwtTokenInfo() Returns decoded JWT token used by the client.
com.fasterxml.jackson.databind.JsonNode	getRequest(String path) Performs a HTTP GET request and returns the JSON response.
int	getRequestWithOnlyResponseCode(String path) Performs a HTTP GET request and returns the response code only.
com.fasterxml.jackson.databind.JsonNode	postRequest(String path, com.fasterxml.jackson.databind.JsonNode data) Performs a HTTP POST request and returns the JSON response.
com.fasterxml.jackson.databind.JsonNode	putRequest(String path, com.fasterxml.jackson.databind.JsonNode data) Performs a HTTP PUT request and returns the JSON response.

Methods inherited from class java.lang.Object

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

Field Detail

mapper

protected final com.fasterxml.jackson.databind.ObjectMapper mapper

Constructor Detail

JsonRestClient

public JsonRestClient(JsonRestClientConfiguration cfg)

Creates the client and performs the client authentication.

Parameters:

cfg - client configuration

JsonRestClient

public JsonRestClient(JsonRestClientConfiguration cfg,
                      List<org.apache.http.Header> additionalHeaders)

Creates the client and performs the client authentication.

Parameters:

cfg - client configuration

additionalHeaders - additional request headers for the auth request

Method Detail

getRequest

public com.fasterxml.jackson.databind.JsonNode getRequest(String path)
                                                   throws IOException

Performs a HTTP GET request and returns the JSON response.

Parameters:

path - destination URL path

Returns:

JSON response

Throws:

IOException - in case of a problem or the connection was aborted

JsonRestClientResponseException - in case when the response HTTP is not 2xx

getRequestWithOnlyResponseCode

public int getRequestWithOnlyResponseCode(String path)
                                   throws IOException

Performs a HTTP GET request and returns the response code only.

Parameters:

path - destination URL path

Returns:

response code

Throws:

IOException - in case of a problem or the connection was aborted

deleteRequest

public com.fasterxml.jackson.databind.JsonNode deleteRequest(String path)
                                                      throws IOException

Performs a HTTP DELETE request and returns the JSON response.

Parameters:

path - destination URL path

Returns:

JSON response

Throws:

IOException - in case of a problem or the connection was aborted

JsonRestClientResponseException - in case when the response HTTP is not 2xx

putRequest

public com.fasterxml.jackson.databind.JsonNode putRequest(String path,
                                                          com.fasterxml.jackson.databind.JsonNode data)
                                                   throws IOException

Performs a HTTP PUT request and returns the JSON response.

Parameters:

path - destination URL path

data - JSON request body

Returns:

JSON response

Throws:

IOException - in case of a problem or the connection was aborted

JsonRestClientResponseException - in case when the response HTTP is not 2xx

postRequest

public com.fasterxml.jackson.databind.JsonNode postRequest(String path,
                                                           com.fasterxml.jackson.databind.JsonNode data)
                                                    throws IOException

Performs a HTTP POST request and returns the JSON response.

Parameters:

path - destination URL path

data - JSON request body

Returns:

JSON response

Throws:

IOException - in case of a problem or the connection was aborted

JsonRestClientResponseException - in case when the response HTTP is not 2xx

getJwtTokenInfo

public com.fasterxml.jackson.databind.JsonNode getJwtTokenInfo()
                                                        throws IOException

Returns decoded JWT token used by the client.

Returns:

decoded JWT

Throws:

IOException - in case of a problem or the connection was aborted