Package io.goobi.viewer.api.rest

Class AbstractApiUrlManager

java.lang.Object

io.goobi.viewer.api.rest.AbstractApiUrlManager

Direct Known Subclasses:

ApiUrls, ApiUrls

public abstract class AbstractApiUrlManager
extends Object

Author:

florian

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractApiUrlManager.ApiInfo
static class	AbstractApiUrlManager.ApiPath
static class	AbstractApiUrlManager.ApiPathParams
static class	AbstractApiUrlManager.ApiPathQueries
static enum	AbstractApiUrlManager.Version

Constructor Summary

Constructors

Constructor	Description
AbstractApiUrlManager()

Method Summary

Modifier and Type	Method	Description
String	getApiPath()
abstract String	getApiUrl()
abstract String	getApplicationUrl()
AbstractApiUrlManager.ApiInfo	getInfo()	Calls the getApiUrl() and returns a AbstractApiUrlManager.ApiInfo object if a valid response is returned.
String	parseParameter(String template, String url, String param)
AbstractApiUrlManager.ApiPath	path(String... paths)
static String	subPath(String url, String within)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractApiUrlManager

public AbstractApiUrlManager()

Method Details

getApiUrl

public abstract String getApiUrl()

Returns:

The base url to the api without trailing slashes

getApplicationUrl

public abstract String getApplicationUrl()

Returns:

The base url of the viewer application

subPath

public static String subPath(String url,
 String within)

parseParameter

public String parseParameter(String template,
 String url,
 String param)

getApiPath

public String getApiPath()

Returns:

the path part of the getApiUrl()

path

public AbstractApiUrlManager.ApiPath path(String... paths)

Parameters:

paths -

Returns:

AbstractApiUrlManager.ApiPath

getInfo

public AbstractApiUrlManager.ApiInfo getInfo()

Calls the getApiUrl() and returns a AbstractApiUrlManager.ApiInfo object if a valid response is returned. Otherwise an object with empty properties is returned Timeout after a maximum of 3 seconds.

Returns:

AbstractApiUrlManager.ApiInfo