org.gcube.common.gxrest.request

Class GXHTTPStreamRequest

java.lang.Object

org.gcube.common.gxrest.request.GXHTTPStreamRequest

public class GXHTTPStreamRequest
extends Object

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

Author:

Manuele Simi (ISTI CNR)

Field Summary

Fields

Modifier and Type	Field and Description
protected org.gcube.common.gxrest.request.GXConnection	connection
protected static org.slf4j.Logger	logger

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all the parameter except the address.
GXInboundResponse	connect() Sends the CONNECT request to the web application with no body.
GXInboundResponse	connect()
GXInboundResponse	delete() Sends the DELETE request to the web application.
GXInboundResponse	delete() Sends the DELETE request to the web application.
REQUEST	from(String agent) Sets the identity user agent associated to the request.
GXInboundResponse	get() Sends the GET request to the web application.
GXInboundResponse	get() Sends the GET request to the web application.
GXInboundResponse	head() Sends the HEAD request to the web application.
GXInboundResponse	head() Sends the HEAD request to the web application.
REQUEST	header(String name, String value) Add headers to the request.
void	isExternalCall(boolean ext) States if the service being called in an external service (not gCube).
void	isExternalCall(boolean ext)
static GXHTTPStreamRequest	newRequest(String address) Creates a new request.
GXInboundResponse	options() Sends the OPTIONS request to the web application with no body.
GXInboundResponse	options()
GXInboundResponse	patch() Sends the PATCH request to the web application with no body.
GXInboundResponse	patch()
REQUEST	path(String path) Adds s positional path parameter to the request.
GXInboundResponse	post() Sends the POST request to the web application with no body.
GXInboundResponse	post()
GXInboundResponse	post(InputStream body) Sends the POST request to the web application.
GXInboundResponse	put() Sends the PUT request to the web application with no body.
GXInboundResponse	put()
GXInboundResponse	put(InputStream body) Sends the PUT request to the web application.
REQUEST	queryParams(Map<String,String> parameters) Sets the query parameters for the request.
void	setSecurityToken(String token) Overrides the default security token.
void	setSecurityToken(String token) Overrides the default security token.
GXInboundResponse	trace() Sends the TRACE request to the web application with no body.
GXInboundResponse	trace()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

connection

protected org.gcube.common.gxrest.request.GXConnection connection

Method Detail

newRequest

public static GXHTTPStreamRequest newRequest(String address)

Creates a new request.

Parameters:

address - the address of the web app to call

Returns:

the request

put

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

Sends the POST request to the web application.

Parameters:

body - the body of the request

Returns:

the response

Throws:

Exception

put

public GXInboundResponse put()
                      throws Exception

Sends the PUT request to the web application with no body.

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

get

public GXInboundResponse get()
                      throws Exception

Sends the GET request to the web application.

Returns:

the response

Throws:

Exception

post

public GXInboundResponse post()
                       throws Exception

Sends the POST request to the web application with no body.

Returns:

the response

Throws:

Exception

trace

public GXInboundResponse trace()
                        throws Exception

Sends the TRACE request to the web application with no body.

Returns:

the response

Throws:

Exception

patch

public GXInboundResponse patch()
                        throws Exception

Sends the PATCH request to the web application with no body.

Returns:

the response

Throws:

Exception

options

public GXInboundResponse options()
                          throws Exception

Sends the OPTIONS request to the web application with no body.

Returns:

the response

Throws:

Exception

connect

public GXInboundResponse connect()
                          throws Exception

Sends the CONNECT request to the web application with no body.

Returns:

the response

Throws:

Exception

setSecurityToken

public void setSecurityToken(String token)

Overrides the default security token.

Parameters:

token - the new token

isExternalCall

public void isExternalCall(boolean ext)

States if the service being called in an external service (not gCube).

Parameters:

ext - true if external, false otherwise

from

public REQUEST from(String agent)

Sets the identity user agent associated to the request.

Parameters:

agent -

Returns:

the request

path

public REQUEST path(String path)
             throws UnsupportedEncodingException

Adds s positional path parameter to the request.

Parameters:

path -

Returns:

the request

Throws:

UnsupportedEncodingException

queryParams

public REQUEST 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 -

header

public REQUEST header(String name,
                      String value)

Add headers to the request.

Parameters:

name -

value -

put

public GXInboundResponse put()
                      throws Exception

Throws:

Exception

post

public GXInboundResponse post()
                       throws Exception

Throws:

Exception

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.

trace

public GXInboundResponse trace()
                        throws Exception

Throws:

Exception

patch

public GXInboundResponse patch()
                        throws Exception

Throws:

Exception

options

public GXInboundResponse options()
                          throws Exception

Throws:

Exception

connect

public GXInboundResponse connect()
                          throws Exception

Throws:

Exception

isExternalCall

public void isExternalCall(boolean ext)