Index (gCube eXtensions to the Rest Protocol 1.0.0-SNAPSHOT API)

B C D E F G H L N O P Q R S T W

B

build() - Method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Builds the response to return.

C

clear() - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Clears all the parameter except the address.
CodeEntity - Class in org.gcube.common.gxrest.response.entity: An entity to wrap SerializableErrorEntitys into a WebCodeException.
CodeEntity(SerializableErrorEntity) - Constructor for class org.gcube.common.gxrest.response.entity.CodeEntity
CodeFinder - Class in org.gcube.common.gxrest.response.outbound: Helper methods to find an error code in an enumeration implementing ErrorCode.
CodeFinder() - Constructor for class org.gcube.common.gxrest.response.outbound.CodeFinder
configProperty(String, String) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Sets a new property in the request.
ContentUtils - Class in org.gcube.common.gxrest.response.inbound: Manipulation of an GXInboundResponse's content.
ContentUtils() - Constructor for class org.gcube.common.gxrest.response.inbound.ContentUtils

D

decodeElement(String) - Static method in class org.gcube.common.gxrest.response.entity.StackTraceEncoder: Decodes the string as stacktrace element.
decodeTrace(String) - Static method in class org.gcube.common.gxrest.response.entity.StackTraceEncoder
delete() - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Sends the DELETE request to the web application.
delete() - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest

E

encodeElement(StackTraceElement) - Static method in class org.gcube.common.gxrest.response.entity.StackTraceEncoder: Encodes the stacktrace element as string.
encodeTrace(StackTraceElement[], int) - Static method in class org.gcube.common.gxrest.response.entity.StackTraceEncoder
EntityTag - Class in org.gcube.common.gxrest.response.entity: Values of the HTTP Entity Tag, used as the value of an ETag response header.
EntityTag() - Constructor for class org.gcube.common.gxrest.response.entity.EntityTag
ErrorCode - Interface in org.gcube.common.gxrest.response.outbound: Interface for error codes.

F

findAndConvert(ErrorCode, E[]) - Static method in class org.gcube.common.gxrest.response.outbound.CodeFinder: Finds and convert the given code as enum value.
from(String) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Sets the identity user agent associated to the request.
from(String) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Sets the identity user agent associated to the request.
fromJson(byte[], Class<T>) - Static method in class org.gcube.common.gxrest.response.inbound.ContentUtils: Deserializes the specified Json bytes into an object of the specified class
fromJson(String, Class<T>) - Static method in class org.gcube.common.gxrest.response.inbound.ContentUtils: Deserializes the specified Json bytes into an object of the specified class

G

get() - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Sends the GET request to the web application.
get() - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest
getEncodedTrace() - Method in class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
getErrorCode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Gets the ErrorCode inside the entity.
getException() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Gets the Exception inside the entity.
getExceptionClass() - Method in class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
getHeaderFields() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Returns an unmodifiable Map of the header fields.
getHTTPCode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Gets the status code from the HTTP response message.
getId() - Method in class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
getId() - Method in interface org.gcube.common.gxrest.response.outbound.ErrorCode: Identifier of the code.
getId() - Method in exception org.gcube.common.gxrest.response.outbound.LocalCodeException
getMessage() - Method in class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
getMessage() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Gets the message in the response
getMessage() - Method in interface org.gcube.common.gxrest.response.outbound.ErrorCode: The message associated to the code
getMessage() - Method in exception org.gcube.common.gxrest.response.outbound.LocalCodeException
getSource() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse
getStreamedContent() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Returns the content of the response as byte array.
getStreamedContentAsString() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Gets the streamed content as a string, if possible.
gxError - Static variable in class org.gcube.common.gxrest.response.entity.EntityTag
GXHTTPRequest - Class in org.gcube.common.gxrest.request: A context-aware request to a web application.
GXInboundResponse - Class in org.gcube.common.gxrest.response.inbound: The response returned from the web application.
GXInboundResponse(Response) - Constructor for class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Builds a new inbound response.
GXInboundResponse(HttpURLConnection) - Constructor for class org.gcube.common.gxrest.response.inbound.GXInboundResponse
GXInboundResponse(Response, MediaType[]) - Constructor for class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Builds a new inbound response.
GXOutboundErrorResponse - Class in org.gcube.common.gxrest.response.outbound: An outbound error response message for applications.
GXOutboundSuccessResponse - Class in org.gcube.common.gxrest.response.outbound: An outbound success response message for applications.
gxSuccess - Static variable in class org.gcube.common.gxrest.response.entity.EntityTag
GXWebTargetAdapterRequest - Class in org.gcube.common.gxrest.request: A GX request based on JAX-RS.

H

hasBAD_REQUESTCode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if the response has a BAD_REQUEST (400) HTTP status.
hasCREATEDCode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if the response has a CREATED (201) HTTP status.
hasErrorCode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if there is an ErrorCode in the entity.
hasException() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if there is an Exception in the entity.
hasGXError() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if the response was generated as a GXOutboundErrorResponse .
hasNOT_ACCEPTABLECode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if the response has a NOT_ACCEPTABLE (406) HTTP status.
hasOKCode() - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Checks if the response has a OK (200) HTTP status.
hasStackTrace() - Method in class org.gcube.common.gxrest.response.entity.SerializableErrorEntity: Checks if a stacktrace is available.
head() - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Sends the HEAD request to the web application.
head() - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest

L

LocalCodeException - Exception in org.gcube.common.gxrest.response.outbound: A local exception wrapping an ErrorCode.
LocalCodeException(ErrorCode) - Constructor for exception org.gcube.common.gxrest.response.outbound.LocalCodeException

N

newCREATEResponse(URI) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Builds a new response with the CREATE HTTP status.
newOKResponse() - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Builds a new response with the OK HTTP status.
newRequest(String) - Static method in class org.gcube.common.gxrest.request.GXHTTPRequest: Creates a new request.
newRequest(String) - Static method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Creates a new request.

O

ofType(MediaType) - Method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Adds a type to the response message.
ofType(String) - Method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Adds a type to the response message.
org.gcube.common.gxrest.methods - package org.gcube.common.gxrest.methods
org.gcube.common.gxrest.request - package org.gcube.common.gxrest.request: Requests to web application.
org.gcube.common.gxrest.response.entity - package org.gcube.common.gxrest.response.entity: Core data held by a response.
org.gcube.common.gxrest.response.inbound - package org.gcube.common.gxrest.response.inbound: Inbound responses for client applications.
org.gcube.common.gxrest.response.outbound - package org.gcube.common.gxrest.response.outbound: Outbound responses for web applications.

P

path(String) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Adds s positional path parameter to the request.
path(String) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Adds s positional path parameter to the request.
post(String) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest
post(Entity<?>) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest
put(String) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest
put(Entity<?>) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest

Q

queryParams(Map<String, String>) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Sets the query parameters for the request.
queryParams(Map<String, Object[]>) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Sets the query parameters for the request.

R

register(Object) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Register an instance of a custom JAX-RS component (such as an extension provider or a feature meta-provider) to be instantiated and used in the scope of this request.

S

SerializableErrorEntity - Class in org.gcube.common.gxrest.response.entity: An entity that can be serialized in a WebCodeException.
SerializableErrorEntity() - Constructor for class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
SerializableErrorEntity(ErrorCode) - Constructor for class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
SerializableErrorEntity(Exception) - Constructor for class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
SerializableErrorEntity(Exception, int) - Constructor for class org.gcube.common.gxrest.response.entity.SerializableErrorEntity
setAcceptedResponseType(MediaType...) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Defines the accepted response media types.
setSecurityToken(String) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Overrides the default security token.
setSecurityToken(String) - Method in class org.gcube.common.gxrest.request.GXWebTargetAdapterRequest: Overrides the default security token.
StackTraceEncoder - Class in org.gcube.common.gxrest.response.entity: Encoder for StackTraceElement.

T

throwErrorCode(ErrorCode) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Throws the error code to the client.
throwErrorCode(ErrorCode, Response.Status) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Returns the error code to the client with the HTTP status.
throwException(Exception) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Throws the exception to the client.
throwException(Exception, Response.Status) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Throws the exception to the client.
throwExceptionWithTrace(Exception, int, Response.Status) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Throws the exception to the client.
throwExceptionWithTrace(Exception, int) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Throws the exception to the client.
throwHTTPErrorStatus(Response.Status, String) - Static method in class org.gcube.common.gxrest.response.outbound.GXOutboundErrorResponse: Returns the HTTP status to the client as error.
toByteArray(Object) - Static method in class org.gcube.common.gxrest.response.inbound.ContentUtils: Converts an object to an array of bytes
toByteArray(InputStream) - Static method in class org.gcube.common.gxrest.response.inbound.ContentUtils: Gets the contents of an InputStream as a byte[].
toObject(InputStream, Class<T>) - Static method in class org.gcube.common.gxrest.response.inbound.ContentUtils
toObject(byte[]) - Method in class org.gcube.common.gxrest.response.inbound.ContentUtils: Converts the array of bytes into an object.
toString(byte[]) - Static method in class org.gcube.common.gxrest.response.inbound.ContentUtils
tryConvertStreamedContentFromJson(Class<T>) - Method in class org.gcube.common.gxrest.response.inbound.GXInboundResponse: Tries to convert the content from its Json serialization, if possible.

W

withBody(String) - Method in class org.gcube.common.gxrest.request.GXHTTPRequest: Sets the body of the request.
withContent(Object) - Method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Sets the object as response's content.
withContent(InputStream) - Method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Reads from the stream the content to set in the response.
withContent(String) - Method in class org.gcube.common.gxrest.response.outbound.GXOutboundSuccessResponse: Sets the message as the response's content.

B C D E F G H L N O P Q R S T W