Difference between revisions of "GxRest/GxHTTP"
From Gcube Wiki
Manuele.simi (Talk | contribs) (→Working with Streams: GXHTTPStreamRequest) |
Manuele.simi (Talk | contribs) (→Requests) |
||
Line 123: | Line 123: | ||
assertTrue("Unexpected returned code.", response.getResponseCode() == Status.CREATED.getStatusCode()); | assertTrue("Unexpected returned code.", response.getResponseCode() == Status.CREATED.getStatusCode()); | ||
String body = ContentUtils.toString(ContentUtils.toByteArray(response.getInputStream())); | String body = ContentUtils.toString(ContentUtils.toByteArray(response.getInputStream())); | ||
− | System.out.println("Returned | + | System.out.println("Returned response " + body); |
} catch (Exception e) { | } catch (Exception e) { | ||
// handle the error | // handle the error | ||
Line 144: | Line 144: | ||
.header("Another header", "GXHTTPRequestTest") | .header("Another header", "GXHTTPRequestTest") | ||
.queryParams(queryParams).post(bodyStream); | .queryParams(queryParams).post(bodyStream); | ||
− | + | if(response.getResponseCode() == Status.CREATED.getStatusCode()) { | |
− | + | String body = ContentUtils.toString(ContentUtils.toByteArray(response.getInputStream())); | |
− | + | System.out.println("Returned response " + body); | |
+ | } | ||
+ | |||
} catch (Exception e) { | } catch (Exception e) { | ||
// handle the error | // handle the error | ||
} </source> | } </source> |
Revision as of 18:13, 18 January 2019
Contents
Request interface
The org.gcube.common.gxhttp.reference
interface defines the behavior of all the requests in gxRest.
/** * * HTTP methods for requests. * * @author Manuele Simi (ISTI-CNR) * * @param <BODY> the type of the body request * @param <RESPONSE> the type of the response */ public interface GXHTTP<BODY,RESPONSE> { /** * Sends the PUT request to the web application. * @param body the body of the request * @return the response */ RESPONSE put(BODY body) throws Exception; /** * Sends the PUT request to the web application with no body. * @return the response */ RESPONSE put() throws Exception; /** * Sends the DELETE request to the web application. * @return the response */ RESPONSE delete() throws Exception; /** * Sends the HEAD request to the web application. * @return the response */ RESPONSE head() throws Exception; /** * Sends the GET request to the web application. * @return the response */ RESPONSE get() throws Exception; /** * Sends the POST request to the web application. * @param body the body of the request * @return the response * @throws Exception */ RESPONSE post(BODY body) throws Exception; /** * Sends the POST request to the web application with no body. * @return the response * @throws Exception */ RESPONSE post() throws Exception; /** * Sends the TRACE request to the web application with no body. * @return the response * @throws Exception */ RESPONSE trace() throws Exception; /** * Sends the PATCH request to the web application with no body. * @return the response * @throws Exception */ RESPONSE patch() throws Exception; /** * Sends the OPTIONS request to the web application with no body. * @return the response * @throws Exception */ RESPONSE options() throws Exception; /** * Sends the CONNECT request to the web application with no body. * @return the response * @throws Exception */ RESPONSE connect() throws Exception; /** * Overrides the default security token. * @param token the new token */ void setSecurityToken(String token); /** * States if the service being called in an external service (not gCube). * @param ext true if external, false otherwise */ void isExternalCall(boolean ext); }
Requests
Working with Strings: GXHTTPStringRequest
The following snippet shows how to send a POST request with a string in the body:
import java.net.HttpURLConnection; import org.gcube.common.gxhttp.util.ContentUtils; import org.gcube.common.gxhttp.request.GXHTTPStringRequest; GXHTTPStringRequest request = GXHTTPStringRequest.newRequest("Service URL").from("agent"); String context = "..."; Map<String,String> queryParams = new WeakHashMap<>(); queryParams.put("name", value); try { HttpURLConnection response = request.path("gxrest") .header("Another header", "GXHTTPRequestTest") .queryParams(queryParams).post(context); assertTrue("Unexpected returned code.", response.getResponseCode() == Status.CREATED.getStatusCode()); String body = ContentUtils.toString(ContentUtils.toByteArray(response.getInputStream())); System.out.println("Returned response " + body); } catch (Exception e) { // handle the error }
Working with Streams: GXHTTPStreamRequest
The following snippet shows how to send a POST request with a file's content as body:
import java.net.HttpURLConnection; import org.gcube.common.gxhttp.util.ContentUtils; import org.gcube.common.gxhttp.request.GXHTTPStreamRequest; InputStream bodyStream = new FileInputStream("my path"); GXHTTPStreamRequest request = GXHTTPStreamRequest.newRequest("Service URL").from("agent"); Map<String,String> queryParams = new WeakHashMap<>(); queryParams.put("name", value); try { HttpURLConnection response = request.path("gxrest") .header("Another header", "GXHTTPRequestTest") .queryParams(queryParams).post(bodyStream); if(response.getResponseCode() == Status.CREATED.getStatusCode()) { String body = ContentUtils.toString(ContentUtils.toByteArray(response.getInputStream())); System.out.println("Returned response " + body); } } catch (Exception e) { // handle the error }