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.
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.
GemmaRestApiClient.Response	delete(String endpoint)	Issue a DELETE against a given REST endpoint.
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

delete

GemmaRestApiClient.Response delete(String endpoint)
                            throws IOException

Issue a DELETE against a given REST endpoint.

Exists for the admin cache surface, which is only reachable by DELETE. A CLI that rebuilds a table can evict its own JVM's Hibernate regions, but gemma-rest is a different process and learns nothing from that — so the only way for a rebuild to stop the server serving what it cached beforehand is a call like this one.

Returns:

an GemmaRestApiClient.EmptyResponse on a 204, which is what the cache endpoints return on success, or an GemmaRestApiClient.ErrorResponse the caller is expected to inspect

Throws:

IOException

setAuthentication

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

Set credentials used for authenticating API requests.

clearAuthentication

void clearAuthentication()

Clear any credentials.