Package io.jmix.restds.extension

Interface RestDataStoreExtension

All Superinterfaces:

org.springframework.core.Ordered

@NullMarked
public interface RestDataStoreExtension
extends org.springframework.core.Ordered

Extension point of the REST data store. Lets an application add parameters to the requests that the store sends to the remote service, read the JSON of loaded entities, and change the JSON of entities being saved.

Register an implementation as a Spring bean. For each request, the store calls every extension whose supports(String, MetaClass) method returns true, in the order defined by getOrder().

The load and save methods receive root entities only: the entities that are loaded or saved directly, not the entities they reference. Removing entities does not call any method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RestDataStoreExtension.AfterLoadContext	Data passed to afterLoad(AfterLoadContext).
static class	RestDataStoreExtension.AfterSaveContext	Data passed to afterSave(AfterSaveContext).
static class	RestDataStoreExtension.BeforeCountContext	Data passed to beforeCount(BeforeCountContext).
static class	RestDataStoreExtension.BeforeLoadContext	Data passed to beforeLoad(BeforeLoadContext).
static class	RestDataStoreExtension.BeforeSaveContext	Data passed to beforeSave(BeforeSaveContext).

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
default void	afterLoad(RestDataStoreExtension.AfterLoadContext context)	Called for each loaded root entity, with the JSON object the entity was read from.
default void	afterSave(RestDataStoreExtension.AfterSaveContext context)	Called after the remote service returns a saved root entity.
default void	beforeCount(RestDataStoreExtension.BeforeCountContext context)	Called before the store sends a request that counts entities.
default void	beforeLoad(RestDataStoreExtension.BeforeLoadContext context)	Called before the store sends a request that loads entities.
default void	beforeSave(RestDataStoreExtension.BeforeSaveContext context)	Called before the store sends a root entity to be created or updated.
default int	getOrder()
boolean	supports(String dataStoreName, MetaClass metaClass)	Returns whether the store must call this extension for the given data store and entity.

Method Details

supports

boolean supports(String dataStoreName,
 MetaClass metaClass)

Returns whether the store must call this extension for the given data store and entity.

Parameters:

dataStoreName - name of the REST data store

metaClass - metaclass of the entity being loaded, counted or saved

beforeLoad

default void beforeLoad(RestDataStoreExtension.BeforeLoadContext context)

Called before the store sends a request that loads entities.

Parameters put into RestDataStoreExtension.BeforeLoadContext.getRequestParameters() are sent to the remote service: in the query string of a GET request, or as fields of the JSON body when the store uses the search endpoint. Names that the store sets itself (fetchPlan, limit, offset, sort, filter, returnCount) and null values are not allowed.

afterLoad

default void afterLoad(RestDataStoreExtension.AfterLoadContext context)

Called for each loaded root entity, with the JSON object the entity was read from.

JSON properties that the entity's metaclass does not have are skipped when the entity is read, so this method is the only place where they are available. The method is not called when loading by id finds no entity.

beforeCount

default void beforeCount(RestDataStoreExtension.BeforeCountContext context)

Called before the store sends a request that counts entities. Request parameters follow the same rules as in beforeLoad(BeforeLoadContext).

If the count is computed by loading the entities (for example, because in-memory row-level policies apply), beforeLoad(BeforeLoadContext) is called instead.

beforeSave

default void beforeSave(RestDataStoreExtension.BeforeSaveContext context)

Called before the store sends a root entity to be created or updated. Changes made to RestDataStoreExtension.BeforeSaveContext.getEntityJson() are sent to the remote service.

FileRef values in the JSON contain the local names of file storages. The store replaces them with the remote names after this method.

afterSave

default void afterSave(RestDataStoreExtension.AfterSaveContext context)

Called after the remote service returns a saved root entity.

The returned JSON contains the attributes of the _base fetch plan only, so values that beforeSave(BeforeSaveContext) added to the request are not in it. Take them from RestDataStoreExtension.AfterSaveContext.getEntity() if needed.

Unless SaveContext.isDiscardSaved() is set, the saved entities are then loaded again, and the caller receives the loaded instances, not RestDataStoreExtension.AfterSaveContext.getSavedEntity(). This load calls beforeLoad(BeforeLoadContext) and afterLoad(AfterLoadContext) with a new LoadContext, which does not have the hints of the save.

getOrder

default int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered