Package ubic.gemma.core.util

Interface GemmaRestApiClient

All Known Implementing Classes:

GemmaRestApiClientImpl

public interface GemmaRestApiClient

A minimalist client for accessing Gemma's RESTful API.

Author:

poirigui

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GemmaRestApiClient.DataResponse
static interface	GemmaRestApiClient.EmptyResponse	For endpoints that return no data (i.e. a 201 No Content reply code).
static interface	GemmaRestApiClient.ErrorResponse	For endpoints that may return an error.
static interface	GemmaRestApiClient.Response	A response from the API, which is either a GemmaRestApiClient.DataResponse or GemmaRestApiClient.ErrorResponse.

Method Summary

Modifier and Type	Method	Description
void	clearAuthentication()	Clear any credentials.
String	getHostUrl()
GemmaRestApiClient.Response	perform(String endpoint)	Access a given REST endpoint.
GemmaRestApiClient.Response	perform(String endpoint, String firstParamName, Object firstParamValue, Object... otherParams)
GemmaRestApiClient.Response	perform(String endpoint, org.springframework.util.MultiValueMap<String,Object> params)	Access a given endpoint REST endpoint with parameters.
void	setAuthentication(org.springframework.security.core.Authentication authentication)	Set credentials used for authenticating API requests.

Method Details

getHostUrl

String getHostUrl()

perform

GemmaRestApiClient.Response perform(String endpoint)
                             throws IOException

Access a given REST endpoint.

Throws:

IOException

perform

GemmaRestApiClient.Response perform(String endpoint,
 org.springframework.util.MultiValueMap<String,Object> params)
                             throws IOException

Access a given endpoint REST endpoint with parameters.

Throws:

IOException - if anything goes wrong with I/O including issues with JSON deserialization

perform

GemmaRestApiClient.Response perform(String endpoint,
 String firstParamName,
 Object firstParamValue,
 Object... otherParams)
                             throws IOException

Throws:

IOException

setAuthentication

void setAuthentication(org.springframework.security.core.Authentication authentication)

Set credentials used for authenticating API requests.

clearAuthentication

void clearAuthentication()

Clear any credentials.