Package io.goobi.viewer.controller

Class RestApiManager

java.lang.Object

io.goobi.viewer.controller.RestApiManager

public class RestApiManager
extends Object

Handles urls to configured rest api endpoints.

Two endpoints are managed: one for data (solr, dao) and one for content (image, ocr, other media) An AbstractApiUrlManager is kept for both. These can either be injected directly in the constructor or resolved from a Configuration. In the latter case, data resources url is taken from Configuration.getRestApiUrl(), content resources url is taken from Configuration.getIIIFApiUrl(). Both urls are updated if the configuration changes. Also, if the configured url contains '/rest' that part is rewritten to '/api/v1' if the rewritten url points to a goobi viewer v1 rest api.

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
RestApiManager()	Creates an instance directly using the unchanged given ApiUrlManagers.
RestApiManager(Configuration config)	Creates an instance based on configuration.

Method Summary

Modifier and Type	Method	Description
AbstractApiUrlManager	getCMSMediaImageApiManager()
AbstractApiUrlManager	getCMSMediaImageApiManager(AbstractApiUrlManager.Version version)
Optional<AbstractApiUrlManager>	getContentApiManager()
Optional<AbstractApiUrlManager>	getContentApiManager(AbstractApiUrlManager.Version version)
String	getContentApiUrl()
Optional<AbstractApiUrlManager>	getDataApiManager()
Optional<AbstractApiUrlManager>	getDataApiManager(AbstractApiUrlManager.Version version)
String	getDataApiUrl()
AbstractApiUrlManager	getIIIFContentApiManager()
String	getIIIFContentApiUrl()
String	getIIIFContentApiUrl(AbstractApiUrlManager.Version version)
AbstractApiUrlManager	getIIIFDataApiManager()
String	getIIIFDataApiUrl()
static AbstractApiUrlManager.Version	getVersionToUseForIIIF()
static boolean	isLegacyUrl(String restApiUrl)

Methods inherited from class java.lang.Object

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

Constructor Details

RestApiManager

public RestApiManager()

Creates an instance directly using the unchanged given ApiUrlManagers.

RestApiManager

public RestApiManager(Configuration config)

Creates an instance based on configuration. Final urls may change from configured ones

Parameters:

config - the viewer configuration to read API URLs from

Method Details

getDataApiManager

public Optional<AbstractApiUrlManager> getDataApiManager()

Returns:

the dataApiManager if it is either set directly or if the configured rest endpoint points to a goobi viewer v1 rest endpoint. Otherwise Null is returned

getDataApiManager

public Optional<AbstractApiUrlManager> getDataApiManager(AbstractApiUrlManager.Version version)

getDataApiUrl

public String getDataApiUrl()

Returns:

The url to the data api. Either AbstractApiUrlManager.getApiUrl() of the getDataApiManager() if it exists, or else the Configured Configuration.getRestApiUrl()

getContentApiUrl

public String getContentApiUrl()

Returns:

The url to the content api. Either AbstractApiUrlManager.getApiUrl() of the getContentApiManager() if it exists, or Else the configured Configuration.getIIIFApiUrl()

getContentApiManager

public Optional<AbstractApiUrlManager> getContentApiManager()

Returns:

the contentApiManager if it is either set directly or if the configured rest endpoint points to a goobi viewer v1 rest endpoint. Otherwise null is returned

getContentApiManager

public Optional<AbstractApiUrlManager> getContentApiManager(AbstractApiUrlManager.Version version)

getCMSMediaImageApiManager

public AbstractApiUrlManager getCMSMediaImageApiManager()

getCMSMediaImageApiManager

public AbstractApiUrlManager getCMSMediaImageApiManager(AbstractApiUrlManager.Version version)

isLegacyUrl

public static boolean isLegacyUrl(String restApiUrl)

Parameters:

restApiUrl - the REST API URL to check

Returns:

true if restApiUrl is legacy URL; false otherwise

getIIIFDataApiUrl

public String getIIIFDataApiUrl()

Returns:

the url to the data api to use for IIIF resources

getIIIFContentApiUrl

public String getIIIFContentApiUrl()

Returns:

the url to the content api to use for IIIF resources

getIIIFContentApiUrl

public String getIIIFContentApiUrl(AbstractApiUrlManager.Version version)

Parameters:

version - the API version to use

Returns:

the url to the content api to use for IIIF resources

getIIIFDataApiManager

public AbstractApiUrlManager getIIIFDataApiManager()

getIIIFContentApiManager

public AbstractApiUrlManager getIIIFContentApiManager()

getVersionToUseForIIIF

public static AbstractApiUrlManager.Version getVersionToUseForIIIF()

Returns:

Appropriate API version to use for IIIF