Package org.gcube.common.gxrest.request

Class GXHTTPStringRequest

java.lang.Object

org.gcube.common.gxrest.request.GXHTTPStringRequest

All Implemented Interfaces:

org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

public class GXHTTPStringRequest
extends Object
implements org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

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 static final org.slf4j.Logger	logger	The logger.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear up the request.
GXInboundResponse	connect()
GXInboundResponse	delete()
GXHTTPStringRequest	from(String agent)	Sets the User-Agent for the request.
GXInboundResponse	get()
GXInboundResponse	head()
GXHTTPStringRequest	header(String name, String value)	Adds a header to the request.
static GXHTTPStringRequest	newRequest(String address)	Creates a new request.
GXInboundResponse	options()
GXInboundResponse	patch()
GXInboundResponse	patch(String body)
GXHTTPStringRequest	path(String path)	Adds a path to the request URL.
GXInboundResponse	post()
GXInboundResponse	post(String body)
GXInboundResponse	purge()
GXInboundResponse	put()
GXInboundResponse	put(String body)
GXHTTPStringRequest	queryParams(Map<String,String> queryParams)	Adds query parameters to the request.
GXInboundResponse	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

Field Details

logger

protected static final org.slf4j.Logger logger

The logger.

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 GXInboundResponse put(String body)
                      throws Exception

Specified by:

put in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

post

public GXInboundResponse post(String body)
                       throws Exception

Specified by:

post in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

patch

public GXInboundResponse patch(String body)
                        throws Exception

Specified by:

patch in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

put

public GXInboundResponse put()
                      throws Exception

Specified by:

put in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

delete

public GXInboundResponse delete()
                         throws Exception

Specified by:

delete in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

purge

public GXInboundResponse purge()
                        throws Exception

Specified by:

purge in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

head

public GXInboundResponse head()
                       throws Exception

Specified by:

head in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

get

public GXInboundResponse get()
                      throws Exception

Specified by:

get in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

post

public GXInboundResponse post()
                       throws Exception

Specified by:

post in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

trace

public GXInboundResponse trace()
                        throws Exception

Specified by:

trace in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

patch

public GXInboundResponse patch()
                        throws Exception

Specified by:

patch in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

options

public GXInboundResponse options()
                          throws Exception

Specified by:

options in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

connect

public GXInboundResponse connect()
                          throws Exception

Specified by:

connect in interface org.gcube.common.gxhttp.reference.GXHTTP<String,GXInboundResponse>

Throws:

Exception

from

public GXHTTPStringRequest from(String agent)

Sets the User-Agent for the request.

Parameters:

agent - the agent

Returns:

the request

clear

public void clear()

Clear up 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