org.gcube.common.gxhttp.request

Class GXHTTPStringRequest

java.lang.Object

org.gcube.common.gxhttp.request.GXHTTPCommonRequest

org.gcube.common.gxhttp.request.GXHTTPStringRequest

All Implemented Interfaces:

GXHTTP<String,HttpURLConnection>

public class GXHTTPStringRequest
extends GXHTTPCommonRequest
implements GXHTTP<String,HttpURLConnection>

A context-aware request to a web application. It supports sending strings through Put/Post requests.

Author:

Manuele Simi (ISTI CNR)

Field Summary

Fields inherited from class org.gcube.common.gxhttp.request.GXHTTPCommonRequest

builder, logger

Method Summary

Modifier and Type	Method and Description
GXHTTPStringRequest	from(String agent)
GXHTTPStringRequest	header(String name, String value)
static GXHTTPStringRequest	newRequest(String address) Creates a new request.
GXHTTPStringRequest	path(String path)
HttpURLConnection	post(String body) Sends the POST request to the web application.
HttpURLConnection	put(String body) Sends the PUT request to the web application.
GXHTTPStringRequest	queryParams(Map<String,String> queryParams)
GXHTTPStringRequest	withBody(String body) Sets the body of the request.

Methods inherited from class org.gcube.common.gxhttp.request.GXHTTPCommonRequest

clear, connect, delete, get, head, isExternalCall, options, patch, post, put, setSecurityToken, trace

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gcube.common.gxhttp.reference.GXHTTP

connect, delete, get, head, isExternalCall, options, patch, post, put, setSecurityToken, trace

Method Detail

newRequest

public static GXHTTPStringRequest newRequest(String address)

Creates a new request.

Parameters:

address - the address of the web app to call

Returns:

the request

withBody

public GXHTTPStringRequest withBody(String body)

Sets the body of the request.

Parameters:

body -

Returns:

the request

put

public HttpURLConnection put(String body)
                      throws Exception

Description copied from interface: GXHTTP

Sends the PUT request to the web application.

Specified by:

put in interface GXHTTP<String,HttpURLConnection>

Parameters:

body - the body of the request

Returns:

the response

Throws:

Exception

post

public HttpURLConnection post(String body)
                       throws Exception

Description copied from interface: GXHTTP

Sends the POST request to the web application.

Specified by:

post in interface GXHTTP<String,HttpURLConnection>

Parameters:

body - the body of the request

Returns:

the response

Throws:

Exception

from

public GXHTTPStringRequest from(String agent)

Parameters:

string -

Returns:

the request

path

public GXHTTPStringRequest path(String path)
                         throws UnsupportedEncodingException

Parameters:

string -

Returns:

the request

Throws:

UnsupportedEncodingException

header

public GXHTTPStringRequest header(String name,
                                  String value)

Parameters:

name -

value -

Returns:

the request

queryParams

public GXHTTPStringRequest queryParams(Map<String,String> queryParams)
                                throws UnsupportedEncodingException

Parameters:

queryParams -

Returns:

the request

Throws:

UnsupportedEncodingException