Package io.jmix.rest.impl

Class RestControllerUtils

java.lang.Object

io.jmix.rest.impl.RestControllerUtils

@Component("rest_RestControllerUtils")
public class RestControllerUtils
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected FetchPlanRepository	fetchPlanRepository
protected FetchPlanSerialization	fetchPlanSerialization
protected Metadata	metadata
protected RestJsonTransformations	restJsonTransformations
protected RestProperties	restProperties

Constructor Summary

Constructors

Constructor	Description
RestControllerUtils()

Method Summary

Modifier and Type	Method	Description
FetchPlan	getFetchPlan(MetaClass metaClass, String name)	Returns a fetch plan by name.
FetchPlan	getFetchPlanByNameOrJson(MetaClass metaClass, String fetchPlanNameOrJson)	Returns a fetch plan by name or deserializes it from JSON.
MetaClass	getMetaClass(String entityName)	Finds metaClass by entityName.
String	transformEntityNameIfRequired(String entityName, String modelVersion, JsonTransformationDirection direction)
String	transformJsonIfRequired(String entityName, String modelVersion, JsonTransformationDirection direction, String json)

Methods inherited from class java.lang.Object

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

Field Details

metadata

@Autowired
protected Metadata metadata

restJsonTransformations

@Autowired
protected RestJsonTransformations restJsonTransformations

fetchPlanRepository

@Autowired
protected FetchPlanRepository fetchPlanRepository

fetchPlanSerialization

@Autowired
protected FetchPlanSerialization fetchPlanSerialization

restProperties

@Autowired
protected RestProperties restProperties

Constructor Details

RestControllerUtils

public RestControllerUtils()

Method Details

getMetaClass

public MetaClass getMetaClass(String entityName)

Finds metaClass by entityName. Throws a RestAPIException if metaClass not found

getFetchPlan

@Nullable
public FetchPlan getFetchPlan(MetaClass metaClass,
 @Nullable
 String name)

Returns a fetch plan by name.

Parameters:

metaClass - entity MetaClass

name - fetch plan name (nullable)

Returns:

a fetch plan by name, or null if name is null

Throws:

RestAPIException - if the fetch plan is not found

getFetchPlanByNameOrJson

@Nullable
public FetchPlan getFetchPlanByNameOrJson(MetaClass metaClass,
 @Nullable
 String fetchPlanNameOrJson)

Returns a fetch plan by name or deserializes it from JSON.

Parameters:

metaClass - entity MetaClass

fetchPlanNameOrJson - fetch plan name or JSON representation (nullable)

Returns:

a fetch plan by name, or null if name is null

Throws:

RestAPIException - if the provided fetch plan is a name, and it's not found in repository. Also, if inline fetch plans are disabled by RestProperties.isInlineFetchPlanEnabled().

transformEntityNameIfRequired

public String transformEntityNameIfRequired(String entityName,
 @Nullable
 String modelVersion,
 JsonTransformationDirection direction)

transformJsonIfRequired

public String transformJsonIfRequired(String entityName,
 @Nullable
 String modelVersion,
 JsonTransformationDirection direction,
 String json)