Index (gCube eXtensions to REST with HTTP 1.1.0-SNAPSHOT API)

A B C D F G H I L N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addBody(String) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The body of the request.
addBodyAsStream(InputStream) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.
addPath(String) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Adds a path part to the connection.
address - Variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The address of the remote service.
APPLICATION_JSON_CHARSET_UTF_8 - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The application/json;charset=UTF-8 content type.
APPLICATION_JSON_CHARSET_UTF_8 - Static variable in class org.gcube.common.gxhttp.request.GXRequest: The application/json;charset=UTF-8 content type.

B

builder - Variable in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

C

clear() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Clears all the parameter except the address.
clear() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Clear up the request.
clear() - Method in class org.gcube.common.gxhttp.request.GXRequest: Clears path, path parameters, query parameters and body, so that the request can be reused with the same address, headers and timeouts.
close() - Method in class org.gcube.common.gxhttp.request.GXResponse: Closes the body, giving the connection back.
connect() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the CONNECT request to the web application with no body.
connect() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
connect() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
CONNECT - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The CONNECT method, which the HTTP client does not send.
CONNECT_TIMEOUT_PROPERTY - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

System property holding the default connect timeout, in milliseconds (0 means infinite).
CONNECT_TIMEOUT_PROPERTY - Static variable in class org.gcube.common.gxhttp.request.GXRequest: System property holding the default connect timeout, in milliseconds (0 means infinite).
connection - Variable in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
connectTimeout(int) - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sets the connect timeout of the request.
connectTimeout(int) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Sets the connect timeout of the request.
connectTimeout(int) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Sets the connect timeout of the request.
connectTimeout(int) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the connect timeout of this request.
ContentUtils - Class in org.gcube.common.gxhttp.util: Manipulation of a response's content.
ContentUtils() - Constructor for class org.gcube.common.gxhttp.util.ContentUtils

D

DEFAULT_CONNECT_TIMEOUT - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Connect timeout used when "gxhttp.connectTimeout" is not set, in milliseconds.
DEFAULT_CONNECT_TIMEOUT - Static variable in class org.gcube.common.gxhttp.request.GXRequest: Connect timeout used when "gxhttp.connectTimeout" is not set, in milliseconds.
DEFAULT_READ_TIMEOUT - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Read timeout used when "gxhttp.readTimeout" is not set, in milliseconds.
DEFAULT_READ_TIMEOUT - Static variable in class org.gcube.common.gxhttp.request.GXRequest: Read timeout used when "gxhttp.readTimeout" is not set, in milliseconds.
delete() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the DELETE request to the web application.
delete() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sends the DELETE request to the web application.
delete() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
delete() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a DELETE request.
DELETE - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The DELETE method.

F

from(String) - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sets the identity user agent associated to the request.
from(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Sets the User-Agent for the request
from(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Sets the User-Agent for the request
from(String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the agent sent as User-Agent.

G

get() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the GET request to the web application.
get() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sends the GET request to the web application.
get() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
get() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a GET request.
GET - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The GET method.
getBody() - Method in class org.gcube.common.gxhttp.request.GXResponse
getBodyAsString() - Method in class org.gcube.common.gxhttp.request.GXResponse: Reads the whole body as UTF-8 text and closes it.
getDefaultConnectTimeout() - Static method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Gets the default connect timeout: "gxhttp.connectTimeout" when set, otherwise 30000.
getDefaultConnectTimeout() - Static method in class org.gcube.common.gxhttp.request.GXRequest: Gets the default connect timeout: "gxhttp.connectTimeout" when set, otherwise 30000.
getDefaultReadTimeout() - Static method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Gets the default read timeout: "gxhttp.readTimeout" when set, otherwise 300000.
getDefaultReadTimeout() - Static method in class org.gcube.common.gxhttp.request.GXRequest: Gets the default read timeout: "gxhttp.readTimeout" when set, otherwise 300000.
getHeader(String) - Method in class org.gcube.common.gxhttp.request.GXResponse
getHeaders() - Method in class org.gcube.common.gxhttp.request.GXResponse
getStatus() - Method in class org.gcube.common.gxhttp.request.GXResponse
getURI() - Method in class org.gcube.common.gxhttp.request.GXRequest
getURI() - Method in class org.gcube.common.gxhttp.request.GXResponse
GXConnection - Class in org.gcube.common.gxhttp.reference: Deprecated, for removal: This API element is subject to removal in a future version.
use GXRequest, which returns a GXResponse
GXConnection(String) - Constructor for class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Creates a new connection.
GXConnection.HTTPMETHOD - Enum Class in org.gcube.common.gxhttp.reference: Deprecated.

The HTTP methods.
GXHTTP<BODY,RESPONSE> - Interface in org.gcube.common.gxhttp.reference: Deprecated, for removal: This API element is subject to removal in a future version.
use GXRequest, which returns a GXResponse
GXHTTPRequestBuilder - Class in org.gcube.common.gxhttp.reference: Deprecated, for removal: This API element is subject to removal in a future version.
use GXRequest, which returns a GXResponse
GXHTTPRequestBuilder() - Constructor for class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
GXHTTPStreamRequest - Class in org.gcube.common.gxhttp.request: Deprecated, for removal: This API element is subject to removal in a future version.
use GXRequest, which returns a GXResponse
GXHTTPStringRequest - Class in org.gcube.common.gxhttp.request: Deprecated, for removal: This API element is subject to removal in a future version.
use GXRequest, which returns a GXResponse
GXRequest - Class in org.gcube.common.gxhttp.request: An HTTP request to a remote service, sent with the JDK HttpClient.
GXResponse - Class in org.gcube.common.gxhttp.request: The response to a GXRequest: status, headers and body.
GXResponseException - Exception in org.gcube.common.gxhttp.reference: Thrown when a request was handed to the server but no response status was received (e.g. the read timeout expired, or the connection was closed while waiting for the response): the server may have processed the request, so resending it may repeat its effect.
GXResponseException(String, Throwable) - Constructor for exception org.gcube.common.gxhttp.reference.GXResponseException: Creates the exception.

H

head() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the HEAD request to the web application.
head() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sends the HEAD request to the web application.
head() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
head() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a HEAD request.
HEAD - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The HEAD method.
header(String, String) - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Add headers to the request.
header(String, String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Adds a header to the request
header(String, String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Adds a header to the request
header(String, String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets a header.

I

isSuccessful() - Method in class org.gcube.common.gxhttp.request.GXResponse

L

logger - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The logger.
logger - Static variable in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
logger - Static variable in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

N

newRequest(String) - Static method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Creates a new request.
newRequest(String) - Static method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Creates a new request.
newRequest(String) - Static method in class org.gcube.common.gxhttp.request.GXRequest: Creates a request.

O

options() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the OPTIONS request to the web application with no body.
options() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
options() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
options() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends an OPTIONS request.
OPTIONS - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The OPTIONS method.
org.gcube.common.gxhttp.reference - package org.gcube.common.gxhttp.reference: GXHTTP core.
org.gcube.common.gxhttp.request - package org.gcube.common.gxhttp.request: GXHTTP requests.
org.gcube.common.gxhttp.util - package org.gcube.common.gxhttp.util: Utilities.

P

PARAM_EQUALS - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The parameter equals.
PARAM_EQUALS - Static variable in class org.gcube.common.gxhttp.request.GXRequest: The parameter equals.
PARAM_SEPARATOR - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The parameter separator.
PARAM_SEPARATOR - Static variable in class org.gcube.common.gxhttp.request.GXRequest: The parameter separator.
PARAM_STARTER - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The parameter starter.
PARAM_STARTER - Static variable in class org.gcube.common.gxhttp.request.GXRequest: The parameter starter.
patch() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the PATCH request to the web application with no body.
patch() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
patch() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
patch() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a PATCH request, with the body if set.
patch(BODY) - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the PATCH request to the web application.
patch(InputStream) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
patch(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.
PATCH - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The PATCH method.
path(String) - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Adds s positional path parameter to the request.
path(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Adds a path to the request URL
path(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Adds a path to the request URL
path(String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Appends a part to the path; each segment is encoded.
PATH_SEPARATOR - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The path separator.
PATH_SEPARATOR - Static variable in class org.gcube.common.gxhttp.request.GXRequest: The path separator.
pathParams(String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets path parameters, appended as they are after the path (e.g.
post() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the POST request to the web application with no body.
post() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
post() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
post() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a POST request, with the body if set.
post(BODY) - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the POST request to the web application.
post(InputStream) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
post(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.
POST - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The POST method.
purge() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the PURGE request to the web application.
purge() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sends the PURGE request to the web application.
purge() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
purge() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a PURGE request.
PURGE - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The PURGE method.
put() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the PUT request to the web application with no body.
put() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
put() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
put() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a PUT request, with the body if set.
put(BODY) - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the PUT request to the web application.
put(InputStream) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
put(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.
PUT - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The PUT method.

Q

queryParams(Map<String, String>) - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sets the query parameters for the request.
queryParams(Map<String, String>) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Adds query parameters to the request
queryParams(Map<String, String>) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Adds query parameters to the request
queryParams(Map<String, String>) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the query parameters; names and values are encoded.
queryString(String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the query string as it is.

R

READ_TIMEOUT_PROPERTY - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

System property holding the default read timeout, in milliseconds (0 means infinite).
READ_TIMEOUT_PROPERTY - Static variable in class org.gcube.common.gxhttp.request.GXRequest: System property holding the default read timeout, in milliseconds (0 means infinite).
readTimeout(int) - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

Sets the read timeout of the request.
readTimeout(int) - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.

Sets the read timeout of the request.
readTimeout(int) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Sets the read timeout of the request.
readTimeout(int) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the read timeout of this request: the time allowed, once connected, to receive the response status and headers.
reset() - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Resets the connection.

S

send(String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends the request with the given method.
send(GXConnection.HTTPMETHOD) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Sends the request with the given method
setAgent(String) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Sets the agent for the connection.
setConnectTimeout(int) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Sets the connect timeout of this connection.
setPathParameters(String) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Sets the path parameters for the connection.
setProperty(String, String) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Adds a property as header.
setQueryParameters(String) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Sets the query parameters for the connection.
setReadTimeout(int) - Method in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

Sets the read timeout of this connection.

T

toByteArray(InputStream) - Static method in class org.gcube.common.gxhttp.util.ContentUtils: Gets the contents of an InputStream as a byte[].
toByteArray(Object) - Static method in class org.gcube.common.gxhttp.util.ContentUtils: Converts an object to an array of bytes
toObject(byte[]) - Method in class org.gcube.common.gxhttp.util.ContentUtils: Converts the array of bytes into an object.
toObject(InputStream, Class<T>) - Static method in class org.gcube.common.gxhttp.util.ContentUtils: Converts an input stream to an object.
toString() - Method in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.
toString(byte[]) - Static method in class org.gcube.common.gxhttp.util.ContentUtils: Converts a byte array to a string.
trace() - Method in interface org.gcube.common.gxhttp.reference.GXHTTP: Deprecated.

Sends the TRACE request to the web application with no body.
trace() - Method in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.
trace() - Method in class org.gcube.common.gxhttp.request.GXHTTPStreamRequest: Deprecated.
trace() - Method in class org.gcube.common.gxhttp.request.GXRequest: Sends a TRACE request.
TRACE - Enum constant in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

The TRACE method.

U

UTF8 - Static variable in class org.gcube.common.gxhttp.reference.GXConnection: Deprecated.

The UTF-8 charset.
UTF8 - Static variable in class org.gcube.common.gxhttp.request.GXRequest: The UTF-8 charset.
UUID_REGEX - Static variable in class org.gcube.common.gxhttp.reference.GXHTTPRequestBuilder: Deprecated.

V

valueOf(String) - Static method in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.gcube.common.gxhttp.reference.GXConnection.HTTPMETHOD: Deprecated.

Returns an array containing the constants of this enum class, in the order they are declared.

W

withBody(InputStream) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the body as a stream, read while the request is sent.
withBody(String) - Method in class org.gcube.common.gxhttp.request.GXHTTPStringRequest: Deprecated.

Sets the body of the request.
withBody(String) - Method in class org.gcube.common.gxhttp.request.GXRequest: Sets the body as text, sent in UTF-8.

A B C D F G H I L N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form