org.gcube.common.gxrest.request

Class GXWebTargetAdapterRequest

java.lang.Object

org.gcube.common.gxrest.request.GXWebTargetAdapterRequest

public class GXWebTargetAdapterRequest
extends Object

A GX request based on JAX-RS. It requires a runtime implementation of JAX-RS on the classpath (e.g. Jersey) to work.

Author:

Manuele Simi (ISTI CNR)

Method Summary

Modifier and Type	Method and Description
GXWebTargetAdapterRequest	configProperty(String name, String value) Sets a new property in the request.
GXInboundResponse	connect() Sends the CONNECT request to the web application with no body.
GXInboundResponse	delete() Sends the DELETE request to the web application.
GXWebTargetAdapterRequest	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.
GXWebTargetAdapterRequest	header(String name, Object value) Add an arbitrary header.
void	isExternalCall(boolean ext) States if the service being called in an external service (not gCube).
static GXWebTargetAdapterRequest	newHTTPSRequest(String address)
static GXWebTargetAdapterRequest	newRequest(String address) Creates a new request.
GXInboundResponse	options() Sends the OPTIONS request to the web application with no body.
GXInboundResponse	patch() Sends the PATCH request to the web application with no body.
GXWebTargetAdapterRequest	path(String path) Adds a positional path parameter to the request.
GXInboundResponse	post() Sends the POST request to the web application with no body.
GXInboundResponse	post(javax.ws.rs.client.Entity<?> body) Sends the POST request to the web application.
GXInboundResponse	put() Sends the PUT request to the web application with no body.
GXInboundResponse	put(javax.ws.rs.client.Entity<?> body) Sends the PUT request to the web application.
GXWebTargetAdapterRequest	queryParams(Map<String,Object[]> parameters) Sets the query parameters for the request.
GXWebTargetAdapterRequest	register(Class<?> component) Registers a class 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.
GXWebTargetAdapterRequest	register(Object component) Registers 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.
GXWebTargetAdapterRequest	setAcceptedResponseType(javax.ws.rs.core.MediaType... acceptedResponseTypes) Defines the accepted response media types.
void	setSecurityToken(String token) Overrides the default security token.
GXInboundResponse	trace() Sends the TRACE request to the web application with no body.

Methods inherited from class java.lang.Object

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

Method Detail

newRequest

public static GXWebTargetAdapterRequest newRequest(String address)

Creates a new request.

Parameters:

address - the address of the web app to call

Returns:

the request

newHTTPSRequest

public static GXWebTargetAdapterRequest newHTTPSRequest(String address)

setSecurityToken

public void setSecurityToken(String token)

Overrides the default security token.

Parameters:

token - the new token

from

public GXWebTargetAdapterRequest from(String agent)

Sets the identity user agent associated to the request.

Parameters:

agent -

Returns:

the request

configProperty

public GXWebTargetAdapterRequest configProperty(String name,
                                                String value)

Sets a new property in the request.

Parameters:

name - the name of the property

value - the value of the property

Returns:

the request

register

public GXWebTargetAdapterRequest register(Object component)

Registers 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.

Parameters:

component - the component to register

Returns:

the request

register

public GXWebTargetAdapterRequest register(Class<?> component)

Registers a class 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.

Parameters:

component - the class of the component to register

Returns:

the request

path

public GXWebTargetAdapterRequest path(String path)
                               throws UnsupportedEncodingException

Adds a positional path parameter to the request.

Parameters:

path - the new token in the path

Returns:

the request

Throws:

UnsupportedEncodingException

queryParams

public GXWebTargetAdapterRequest queryParams(Map<String,Object[]> 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

setAcceptedResponseType

public GXWebTargetAdapterRequest setAcceptedResponseType(javax.ws.rs.core.MediaType... acceptedResponseTypes)

Defines the accepted response media types.

Parameters:

acceptedResponseTypes - accepted response media types.

Returns:

builder for a request targeted at the URI referenced by this target instance.

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

header

public GXWebTargetAdapterRequest header(String name,
                                        Object value)

Add an arbitrary header.

Returns:

the builder

put

public GXInboundResponse put(javax.ws.rs.client.Entity<?> body)
                      throws Exception

Sends the PUT 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

post

public GXInboundResponse post(javax.ws.rs.client.Entity<?> body)
                       throws Exception

Sends the POST request to the web application.

Parameters:

body - the body of the request

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

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