GXWebTargetAdapterRequest (gCube eXtensions to the Rest Protocol 0.0.1-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)

Constructor Summary

Constructors
Constructor and Description

GXWebTargetAdapterRequest(String address)

Constructors
Constructor and Description
`GXWebTargetAdapterRequest(String address)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GXInboundResponse`	`delete()` Sends the DELETE request to the web application.
`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()` Sends the POST request to the web application.
`GXWebTargetAdapterRequest`	`property(String name, String value)` Sets a new property in the request.
`GXInboundResponse`	`put()` Sends the PUT request to the web application.
`GXWebTargetAdapterRequest`	`queryParams(Map<String,String> parameters)` Sets the query parameters for the request.
`void`	`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.
`GXWebTargetAdapterRequest`	`setSecurityToken(String token)` Overrides the default security token.
`GXWebTargetAdapterRequest`	`withEntity(javax.ws.rs.client.Entity<?> entity)` Sets the body of the request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GXWebTargetAdapterRequest
```
public GXWebTargetAdapterRequest(String address)
```
    Parameters:
    
    address -
- 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 GXWebTargetAdapterRequest setSecurityToken(String token)
```
    Overrides the default security token.
    
    Parameters:
    
    token -
    
    Returns:
    
    the request
  - property
```
public GXWebTargetAdapterRequest property(String name,
                                          String value)
```
    Sets a new property in the request.
    
    Parameters:
    
    name -
    
    value -
    
    Returns:
    
    the request
  - register
```
public void 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 -
  - 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
  - withEntity
```
public GXWebTargetAdapterRequest withEntity(javax.ws.rs.client.Entity<?> entity)
```
    Sets the body of the request.
    
    Parameters:
    
    body -
    
    Returns:
    
    the request
  - put
```
public GXInboundResponse put()
                      throws Exception
```
    Sends the PUT request to the web application.
    
    Returns:
    
    the response
    
    Throws:
    
    Exception
  - delete
```
public GXInboundResponse delete()
                         throws Exception
```
    Sends the DELETE request to the web application.
    
    Returns:
    
    the response
    
    Throws:
    
    Exception
  - post
```
public GXInboundResponse post()
                       throws Exception
```
    Sends the POST 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

Class GXWebTargetAdapterRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GXWebTargetAdapterRequest

Method Detail

newRequest

setSecurityToken

property

register

path

queryParams

withEntity

put

delete

post

head

get