es.upv.i3m.grycap.im.rest.client

Class ImClient

java.lang.Object

es.upv.i3m.grycap.im.rest.client.ImClient

public class ImClient
extends Object

Manage the REST methods to communicate with the IM infrastructure.

Constructor Summary

Constructors

Constructor and Description
ImClient(String targetUrl, Path authFilePath) Creates a new client using the 'imServiceUrl' as endpoint. Loads the authorization file from the parameter 'authFilePath'.
ImClient(String targetUrl, String authorizationHeader) Creates a new client using the 'imServiceUrl' as endpoint. Loads the authorization credentials from the 'authorizationHeader' parameter.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.client.Invocation.Builder	configureClient(String path, RestParameter... parameters) Returns a Rest client configured with the specified properties.
<T> T	delete(String path, Class<T> type, RestParameter... parameters) Generic DELETE call.
<T> T	get(String path, Class<T> type, RestParameter... parameters) Generic GET call
<T> T	post(String path, Class<T> type, RestParameter... parameters) Simplified POST call.
<T> T	post(String path, String bodyContent, String contentType, Class<T> type, RestParameter... parameters) Generic POST call.
<T> T	put(String path, Class<T> type, RestParameter... parameters) Simplified PUT call.
<T> T	put(String path, String bodyContent, String contentType, Class<T> type, RestParameter... parameters) Generic PUT call.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImClient

public ImClient(String targetUrl,
                Path authFilePath)
         throws ImClientException

Creates a new client using the 'imServiceUrl' as endpoint.
Loads the authorization file from the parameter 'authFilePath'.

Parameters:

targetUrl - : url of the IM rest service

authFilePath - : path to the authorization file

Throws:

ImClientException

ImClient

public ImClient(String targetUrl,
                String authorizationHeader)
         throws ImClientException

Creates a new client using the 'imServiceUrl' as endpoint.
Loads the authorization credentials from the 'authorizationHeader' parameter.

Parameters:

targetUrl - : url of the IM rest service

authorizationHeader - : string with the authorization content

Throws:

ImClientException

Method Detail

get

public <T> T get(String path,
                 Class<T> type,
                 RestParameter... parameters)
          throws ImClientException

Generic GET call

Type Parameters:

T - : class returned by the call

Parameters:

path - : specific path for the call (e.g. infrastructures/02154-659a)

parameters - : extra parameters for the call (if needed)

Throws:

ImClientException

delete

public <T> T delete(String path,
                    Class<T> type,
                    RestParameter... parameters)
             throws ImClientException

Generic DELETE call.

Throws:

ImClientException

post

public <T> T post(String path,
                  Class<T> type,
                  RestParameter... parameters)
           throws ImClientException

Simplified POST call.

Throws:

ImClientException

post

public <T> T post(String path,
                  String bodyContent,
                  String contentType,
                  Class<T> type,
                  RestParameter... parameters)
           throws ImClientException

Generic POST call.

Throws:

ImClientException

put

public <T> T put(String path,
                 Class<T> type,
                 RestParameter... parameters)
          throws ImClientException

Simplified PUT call.

Throws:

ImClientException

put

public <T> T put(String path,
                 String bodyContent,
                 String contentType,
                 Class<T> type,
                 RestParameter... parameters)
          throws ImClientException

Generic PUT call.

Throws:

ImClientException

configureClient

public javax.ws.rs.client.Invocation.Builder configureClient(String path,
                                                             RestParameter... parameters)
                                                      throws ImClientException

Returns a Rest client configured with the specified properties.

Parameters:

path - : path where the client is going to connect (e.g. /infrastructures/asdalk-asd34/vms)

parameters - : extra parameters for the call (if needed)

Returns:

: REST client

Throws:

ImClientException