GXWebTargetAdapterRequest (gCube eXtensions to the Rest Protocol 0.0.2-SNAPSHOT API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GXWebTargetAdapterRequest`	`configProperty(String name, String value)` Sets a new property in the request.
`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.
`static GXWebTargetAdapterRequest`	`newRequest(String address)` Creates a new request.
`GXWebTargetAdapterRequest`	`path(String path)` Adds s positional path parameter to the request.
`GXInboundResponse`	`post(javax.ws.rs.client.Entity<?> body)` Sends the POST request to the web application.
`GXInboundResponse`	`put(javax.ws.rs.client.Entity<?> body)` Sends the PUT request to the web application.
`GXWebTargetAdapterRequest`	`queryParams(Map<String,String> parameters)` Sets the query parameters for the request.
`GXWebTargetAdapterRequest`	`register(Object component)` 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.
`void`	`setSecurityToken(String token)` Overrides the default security token.

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
  - setSecurityToken
```
public void setSecurityToken(String token)
```
    Overrides the default security token.
    
    Parameters:
    
    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 -
    
    value -
    
    Returns:
    
    the request
  - register
```
public GXWebTargetAdapterRequest register(Object component)
```
    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.
    
    Parameters:
    
    component - the compontent to register
    
    Returns:
    
    the request
  - path
```
public GXWebTargetAdapterRequest path(String path)
                               throws UnsupportedEncodingException
```
    Adds s positional path parameter to the request.
    
    Parameters:
    
    path -
    
    Returns:
    
    the request
    
    Throws:
    
    UnsupportedEncodingException
  - queryParams
```
public GXWebTargetAdapterRequest 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
  - 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
  - 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
  - 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

Class GXWebTargetAdapterRequest

Method Summary

Methods inherited from class java.lang.Object

Method Detail

newRequest

setSecurityToken

from

configProperty

register

path

queryParams

delete

head

get

put

post