Package org.gcube.common.gxhttp.request

Class GXHTTPStringRequest

java.lang.Object

org.gcube.common.gxhttp.request.GXHTTPStringRequest

All Implemented Interfaces:

GXHTTP<String,HttpURLConnection>

public class GXHTTPStringRequest
extends Object
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), Luca Frosini (ISTI-CNR)

Field Summary

Fields

Modifier and Type	Field	Description
protected GXHTTPRequestBuilder	builder
protected static final org.slf4j.Logger	logger

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear up the request.
HttpURLConnection	connect()
HttpURLConnection	delete()
GXHTTPStringRequest	from(String agent)	Sets the User-Agent for the request
HttpURLConnection	get()
HttpURLConnection	head()
GXHTTPStringRequest	header(String name, String value)	Adds a header to the request
static GXHTTPStringRequest	newRequest(String address)	Creates a new request.
HttpURLConnection	options()
HttpURLConnection	patch()
HttpURLConnection	patch(String body)	Sends the PATCH request to the web application.
GXHTTPStringRequest	path(String path)	Adds a path to the request URL
HttpURLConnection	post()
HttpURLConnection	post(String body)	Sends the POST request to the web application.
HttpURLConnection	purge()
HttpURLConnection	put()
HttpURLConnection	put(String body)	Sends the PUT request to the web application.
GXHTTPStringRequest	queryParams(Map<String,String> queryParams)	Adds query parameters to the request
HttpURLConnection	trace()
GXHTTPStringRequest	withBody(String body)	Sets the body of the request.

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, options, patch, post, purge, put, trace

Field Details

logger

protected static final org.slf4j.Logger logger

builder

protected GXHTTPRequestBuilder builder

Method Details

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 - the 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 - if an error occurs

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 - if an error occurs

patch

public HttpURLConnection patch(String body)
                        throws Exception

Description copied from interface: GXHTTP

Sends the PATCH request to the web application.

Specified by:

patch in interface GXHTTP<String,HttpURLConnection>

Parameters:

body - the body of the request

Returns:

the response

Throws:

Exception - if an error occurs

from

public GXHTTPStringRequest from(String agent)

Sets the User-Agent for the request

Parameters:

agent - the agent

Returns:

the request

path

public GXHTTPStringRequest path(String path)
                         throws UnsupportedEncodingException

Adds a path to the request URL

Parameters:

path - the path to add

Returns:

the request

Throws:

UnsupportedEncodingException - if the encoding is not supported

header

public GXHTTPStringRequest header(String name,
 String value)

Adds a header to the request

Parameters:

name - the name of the header

value - the value of the header

Returns:

the request

queryParams

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

Adds query parameters to the request

Parameters:

queryParams - the query parameters

Returns:

the request

Throws:

UnsupportedEncodingException - if the encoding is not supported

put

public HttpURLConnection put()
                      throws Exception

Throws:

Exception

delete

public HttpURLConnection delete()
                         throws Exception

Throws:

Exception

purge

public HttpURLConnection purge()
                        throws Exception

Throws:

Exception

head

public HttpURLConnection head()
                       throws Exception

Throws:

Exception

get

public HttpURLConnection get()
                      throws Exception

Throws:

Exception

post

public HttpURLConnection post()
                       throws Exception

Throws:

Exception

trace

public HttpURLConnection trace()
                        throws Exception

Throws:

Exception

patch

public HttpURLConnection patch()
                        throws Exception

Throws:

Exception

options

public HttpURLConnection options()
                          throws Exception

Throws:

Exception

connect

public HttpURLConnection connect()
                          throws Exception

Throws:

Exception

clear

public void clear()

Clear up the request.