Package org.gcube.common.gxrest.request

Class GXWebTargetAdapterRequest

java.lang.Object

org.gcube.common.gxrest.request.GXWebTargetAdapterRequest

All Implemented Interfaces:

org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

public class GXWebTargetAdapterRequest
extends Object
implements org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

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), Luca Frosini (ISTI-CNR)

Method Summary

Modifier and Type	Method	Description
GXWebTargetAdapterRequest	configProperty(String name, String value)	Sets a new property in the request.
GXInboundResponse	connect()
GXInboundResponse	delete()
GXWebTargetAdapterRequest	from(String agent)	Sets the identity user agent associated to the request.
GXInboundResponse	get()
GXInboundResponse	head()
GXWebTargetAdapterRequest	header(String name, Object value)	Add an arbitrary header.
static GXWebTargetAdapterRequest	newHTTPSRequest(String address)	Creates a new request.
static GXWebTargetAdapterRequest	newHTTPSRequest(String address, String tslprotocol)	Creates a new secure request.
static GXWebTargetAdapterRequest	newRequest(String address)	Creates a new request.
GXInboundResponse	options()
GXInboundResponse	patch()
GXInboundResponse	patch(jakarta.ws.rs.client.Entity<?> body)
GXWebTargetAdapterRequest	path(String path)	Adds a positional path parameter to the request.
GXInboundResponse	post()
GXInboundResponse	post(jakarta.ws.rs.client.Entity<?> body)
GXInboundResponse	purge()
GXInboundResponse	put()
GXInboundResponse	put(jakarta.ws.rs.client.Entity<?> body)
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(jakarta.ws.rs.core.MediaType... acceptedResponseTypes)	Defines the accepted response media types.
GXInboundResponse	trace()

Methods inherited from class java.lang.Object

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

Method Details

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,
 String tslprotocol)

Creates a new secure request.

Parameters:

address - the address of the web app to call

tslprotocol - the secure socket protocol to use in the call

Returns:

the request

newHTTPSRequest

public static GXWebTargetAdapterRequest newHTTPSRequest(String address)

Creates a new request.

Parameters:

address - the address of the web app to call

Returns:

the request

from

public GXWebTargetAdapterRequest from(String agent)

Sets the identity user agent associated to the request.

Parameters:

agent - the 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 - if the encoding is not supported

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 - if the encoding is not supported

setAcceptedResponseType

public GXWebTargetAdapterRequest setAcceptedResponseType(jakarta.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

Specified by:

delete in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

purge

public GXInboundResponse purge()
                        throws Exception

Specified by:

purge in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

head

public GXInboundResponse head()
                       throws Exception

Specified by:

head in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

get

public GXInboundResponse get()
                      throws Exception

Specified by:

get in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

header

public GXWebTargetAdapterRequest header(String name,
 Object value)

Add an arbitrary header.

Parameters:

name - the name of the header

value - the value of the header

Returns:

the builder

put

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

Specified by:

put in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

put

public GXInboundResponse put()
                      throws Exception

Specified by:

put in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

post

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

Specified by:

post in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

post

public GXInboundResponse post()
                       throws Exception

Specified by:

post in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

patch

public GXInboundResponse patch(jakarta.ws.rs.client.Entity<?> body)
                        throws Exception

Specified by:

patch in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

patch

public GXInboundResponse patch()
                        throws Exception

Specified by:

patch in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

trace

public GXInboundResponse trace()
                        throws Exception

Specified by:

trace in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

options

public GXInboundResponse options()
                          throws Exception

Specified by:

options in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception

connect

public GXInboundResponse connect()
                          throws Exception

Specified by:

connect in interface org.gcube.common.gxhttp.reference.GXHTTP<jakarta.ws.rs.client.Entity<?>,GXInboundResponse>

Throws:

Exception