senselogic.sitevision.api.script

Interface VersionedRestApi<O>

Type Parameters:

O - script object

public interface VersionedRestApi<O>

Script utility for server-side invoke of the local Sitevision REST API in a specific version.

Version note! This is an exotic sibling interface to RestApi that can be used to invoke the local Sitevision REST API in a specific version - regardless of what version your code are currently executing in. If you don't know what a version is or haven't thought much about it, you would typically use RestApi that invokes the local REST API in current version.

This utility can be used regardless of the REST API of the local site is enabled or not!

Performance note! RestApi will always outperform VersionedRestApi when executing in the same version! Note that the method contracts of the interfaces differs. RestApi operates on Node objects and VersionedRestApi operates on Strings (i.e. Node identifiers).

An instance of the Sitevision class implementing this interface can be obtained via RestApiFactory.getOfflineRestApi() or RestApiFactory.getOnlineRestApi(). See RestApiFactory for how to obtain an instance of the RestApiFactory interface.

Since:

Sitevision 2024.04.2

Author:

Magnus Lövgren

See Also:

RestApi, RestApiFactory

Method Summary

Modifier and Type	Method and Description
O	delete(String aContextNodeIdentifier, String aOperationName) Executes a DELETE endpoint of the REST API.
O	delete(String aContextNodeIdentifier, String aOperationName, String aOperationNodeIdentifier) Executes a DELETE endpoint of the REST API, targeting an instance of the context.
O	delete(String aContextNodeIdentifier, String aOperationName, String aOperationNodeIdentifier, O aOperationOptions) Executes a DELETE endpoint of the REST API, targeting an instance of the context.
O	get(String aContextNodeIdentifier, String aOperationName) Executes a GET endpoint of the REST API.
O	get(String aContextNodeIdentifier, String aOperationName, O aOperationOptions) Executes a GET endpoint of the REST API.
O	get(String aContextNodeIdentifier, String aOperationName, String aOperationNodeIdentifier, O aOperationOptions) Executes a GET endpoint of the REST API, targeting an instance of the context.
int	getVersion() Get the version that is used by this instance.
O	post(String aContextNodeIdentifier, String aOperationName, O aOperationOptions) Executes a POST endpoint of the REST API.
O	put(String aContextNodeIdentifier, String aOperationName, O aOperationOptions) Executes a PUT endpoint of the REST API.
O	put(String aContextNodeIdentifier, String aOperationName, String aOperationNodeIdentifier, O aOperationOptions) Executes a PUT endpoint of the REST API, targeting an instance of the context.

Method Detail

getVersion

int getVersion()

Get the version that is used by this instance.

Returns:

VersionUtil.OFFLINE_VERSION or VersionUtil.ONLINE_VERSION

get

O get(String aContextNodeIdentifier,
      String aOperationName)

Executes a GET endpoint of the REST API.

Delegates execution to RestApi.get(Node,String) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

Returns:

the result of the RestApi.get(Node,String) invocation

Throws:

NullPointerException - if aContextNodeIdentifier or aOperationName is null

IllegalArgumentException - if aContextNodeIdentifier or aOperationName is empty or blank

get

O get(String aContextNodeIdentifier,
      String aOperationName,
      O aOperationOptions)

Executes a GET endpoint of the REST API.

Delegates execution to RestApi.get(Node,String,Options) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationOptions - the operation data/parameters

Returns:

the result of the RestApi.get(Node,String,Options) invocation

Throws:

NullPointerException - if aContextNodeIdentifier or aOperationName is null

IllegalArgumentException - if aContextNodeIdentifier or aOperationName is empty or blank

get

O get(String aContextNodeIdentifier,
      String aOperationName,
      String aOperationNodeIdentifier,
      O aOperationOptions)

Executes a GET endpoint of the REST API, targeting an instance of the context.

Delegates execution to RestApi.get(Node,String,Node,Options) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationNodeIdentifier - the identifier for the endpoint operation Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationOptions - the operation data/parameters

Returns:

the result of the RestApi.get(Node,String,Node,Options) invocation

Throws:

NullPointerException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null

IllegalArgumentException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank

post

O post(String aContextNodeIdentifier,
       String aOperationName,
       O aOperationOptions)

Executes a POST endpoint of the REST API.

Delegates execution to RestApi.post(Node,String,Options) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationOptions - the operation data/parameters

Returns:

the result of the RestApi.post(Node,String,Options) invocation

Throws:

NullPointerException - if aContextNodeIdentifier or aOperationName is null

IllegalArgumentException - if aContextNodeIdentifier or aOperationName is empty or blank

put

O put(String aContextNodeIdentifier,
      String aOperationName,
      O aOperationOptions)

Executes a PUT endpoint of the REST API.

Delegates execution to RestApi.put(Node,String,Options) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationOptions - the operation data/parameters

Returns:

the result of the RestApi.put(Node,String,Options) invocation

Throws:

NullPointerException - if aContextNodeIdentifier or aOperationName is null

IllegalArgumentException - if aContextNodeIdentifier or aOperationName is empty or blank

put

O put(String aContextNodeIdentifier,
      String aOperationName,
      String aOperationNodeIdentifier,
      O aOperationOptions)

Executes a PUT endpoint of the REST API, targeting an instance of the context.

Delegates execution to RestApi.put(Node,String,Node,Options) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationNodeIdentifier - the identifier for the endpoint operation Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationOptions - the operation data/parameters

Returns:

the result of the RestApi.put(Node,String,Node,Options) invocation

Throws:

NullPointerException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null

IllegalArgumentException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank

delete

O delete(String aContextNodeIdentifier,
         String aOperationName)

Executes a DELETE endpoint of the REST API.

Delegates execution to RestApi.delete(Node,String) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

Returns:

the result of the RestApi.delete(Node,String) invocation

Throws:

NullPointerException - if aContextNodeIdentifier or aOperationName is null

IllegalArgumentException - if aContextNodeIdentifier or aOperationName is empty or blank

delete

O delete(String aContextNodeIdentifier,
         String aOperationName,
         String aOperationNodeIdentifier)

Executes a DELETE endpoint of the REST API, targeting an instance of the context.

Delegates execution to RestApi.delete(Node,String,Node) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationNodeIdentifier - the identifier for the endpoint operation Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

Returns:

the result of the RestApi.delete(Node,String,Node) invocation

Throws:

NullPointerException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null

IllegalArgumentException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank

delete

O delete(String aContextNodeIdentifier,
         String aOperationName,
         String aOperationNodeIdentifier,
         O aOperationOptions)

Executes a DELETE endpoint of the REST API, targeting an instance of the context.

Delegates execution to RestApi.delete(Node,String,Node,Options) in the version specified by this instance.

Parameters:

aContextNodeIdentifier - the identifier for the endpoint context Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationName - the endpoint operation name/method

aOperationNodeIdentifier - the identifier for the endpoint operation Node. Note that there is no guarantee that such a Node exists in the version specified by this instance.

aOperationOptions - the operation data/parameters

Returns:

the result of the RestApi.delete(Node,String,Node,Options) invocation

Throws:

NullPointerException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is null

IllegalArgumentException - if aContextNodeIdentifier, aOperationName or aOperationNodeIdentifier is empty or blank