Package de.dlr.proseo.basewrap.rest

Class RestOps

java.lang.Object

de.dlr.proseo.basewrap.rest.RestOps

public class RestOps
extends Object

Perform REST API calls to a provided endpoint.

Author:

Hubert Asamer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RestOps.HttpMethod	A collection of HTTP Methods.

Constructor Summary

Constructors

Constructor	Description
RestOps()

Method Summary

Modifier and Type	Method	Description
static HttpResponseInfo	restApiCall(String user, String pw, String endPoint, String endPointPath, String payLoad, Map<String,String> queryParams, RestOps.HttpMethod method)	Generic REST API client (currently only supporting GET, PUT and POST)

Methods inherited from class java.lang.Object

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

Constructor Details

RestOps

public RestOps()

Method Details

restApiCall

public static HttpResponseInfo restApiCall(String user,
 String pw,
 String endPoint,
 String endPointPath,
 String payLoad,
 Map<String,String> queryParams,
 RestOps.HttpMethod method)

Generic REST API client (currently only supporting GET, PUT and POST)

Parameters:

user - the user to authenticate with

pw - the password to authenticate with

endPoint - an URL of the REST-Endpoint (e.g. http://localhost:8080)

endPointPath - subroute of REST-URL (e.g. /ingest/param/987398724)

payLoad - the request payload as string

queryParams - the http query parameter (mandatory for PUT, optional for GET)

method - the HTTP method (defaults to POST)

Returns:

response object holding HTTP return code, "Warning" header, if available, and response as String, or null, if the REST request failed with an exception