org.gcube.common.gxrest.request

Class GXHTTPRequest

java.lang.Object

org.gcube.common.gxrest.request.GXHTTPRequest

public class GXHTTPRequest
extends Object

A context-aware request to a web application.

Author:

Manuele Simi (ISTI-CNR), Luca Frosini (ISTI-CNR)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all the parameter except the address.
GXInboundResponse	delete() Sends the DELETE request to the web application.
GXHTTPRequest	from(String agent) Sets the identity user agent associated to the request.
GXInboundResponse	get() Sends the GET request to the web application.
GXInboundResponse	head() Sends the HEAD request to the web application.
static GXHTTPRequest	newRequest(String address) Creates a new request.
GXHTTPRequest	path(String path) Adds s positional path parameter to the request.
GXInboundResponse	post(String body) Sends the POST request to the web application.
GXInboundResponse	put(String body) Sends the PUT request to the web application.
GXHTTPRequest	queryParams(Map<String,String> parameters) Sets the query parameters for the request.
void	setSecurityToken(String token) Overrides the default security token.
GXHTTPRequest	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

Method Detail

newRequest

public static GXHTTPRequest newRequest(String address)

Creates a new request.

Parameters:

address - the address of the web app to call

Returns:

the request

from

public GXHTTPRequest from(String agent)

Sets the identity user agent associated to the request.

Parameters:

agent -

Returns:

the request

path

public GXHTTPRequest path(String path)
                   throws UnsupportedEncodingException

Adds s positional path parameter to the request.

Parameters:

path -

Returns:

the request

Throws:

UnsupportedEncodingException

withBody

public GXHTTPRequest withBody(String body)

Sets the body of the request.

Parameters:

body -

Returns:

the request

queryParams

public GXHTTPRequest queryParams(Map<String,String> parameters)
                          throws UnsupportedEncodingException

Sets the query parameters for the request.

Parameters:

parameters - the parameters that go in the URL after the address and the path params.

Returns:

the request

Throws:

UnsupportedEncodingException

setSecurityToken

public void setSecurityToken(String token)

Overrides the default security token.

Parameters:

token -

get

public GXInboundResponse get()
                      throws Exception

Sends the GET request to the web application.

Returns:

the response

Throws:

Exception

delete

public GXInboundResponse delete()
                         throws Exception

Sends the DELETE request to the web application.

Returns:

the response

Throws:

Exception

head

public GXInboundResponse head()
                       throws Exception

Sends the HEAD request to the web application.

Returns:

the response

Throws:

Exception

clear

public void clear()

Clears all the parameter except the address.

put

public GXInboundResponse put(String body)
                      throws Exception

Sends the PUT request to the web application.

Parameters:

body - the body of the request

Returns:

the response

Throws:

Exception

post

public GXInboundResponse post(String body)
                       throws Exception

Sends the POST request to the web application.

Parameters:

body - the body of the request

Returns:

the response

Throws:

Exception