senselogic.sitevision.api.script

Interface RestApiFactory<O>

Type Parameters:

O - script object

@Requireable(value="RestApiFactory")
public interface RestApiFactory<O>

Factory for creating server-side invokers of the local Sitevision REST API.

REST siblings note!

• Server-side invoke of a local RESTApp should typically be handled via RestAppInvoker.
• Invoking external REST API:s should typically be handled via Requester.

Since:

Sitevision 2024.04.2

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
VersionedRestApi<O>	getOfflineRestApi() Gets the Versioned RestApi utility for the OFFLINE version.
VersionedRestApi<O>	getOnlineRestApi() Gets the Versioned RestApi utility for the ONLINE version.
RestApi<O>	getRestApi() Gets the RestApi utility.

Method Detail

getRestApi

RestApi<O> getRestApi()

Gets the RestApi utility.

The returned utility invokes the local REST API in current version.

Returns:

the RestApi utility

getOnlineRestApi

VersionedRestApi<O> getOnlineRestApi()

Gets the Versioned RestApi utility for the ONLINE version.

The returned utility always invokes the local REST API in the ONLINE version.

Related info: URI prefix for the REST API in the ONLINE version is: /rest-api/1/1/

Returns:

the VersionedRestApi for the ONLINE version

getOfflineRestApi

VersionedRestApi<O> getOfflineRestApi()

Gets the Versioned RestApi utility for the OFFLINE version.

The returned utility always invokes the local REST API in the OFFLINE version.

Related info: URI prefix for the REST API in the OFFLINE version is: /rest-api/1/0/

Returns:

the VersionedRestApi for the OFFLINE version