com.haulmont.restapi.common

Class RestControllerUtils

java.lang.Object

com.haulmont.restapi.common.RestControllerUtils

@Component(value="cuba_RestControllerUtils")
public class RestControllerUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RestControllerUtils()

Method Summary

Modifier and Type	Method and Description
void	applyAttributesSecurity(Entity entity) By default entity is loaded from the middleware with the attributes that are not allowed for reading according to roles permissions.
MetaClass	getMetaClass(java.lang.String entityName) Finds metaClass by entityName.
View	getView(MetaClass metaClass, java.lang.String viewName) Finds a view for a given metaClass.
java.lang.String	transformEntityNameIfRequired(java.lang.String entityName, java.lang.String modelVersion, JsonTransformationDirection direction)
java.lang.String	transformJsonIfRequired(java.lang.String entityName, java.lang.String modelVersion, JsonTransformationDirection direction, java.lang.String json)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestControllerUtils

public RestControllerUtils()

Method Detail

getMetaClass

public MetaClass getMetaClass(java.lang.String entityName)

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

getView

public View getView(MetaClass metaClass,
                    java.lang.String viewName)

Finds a view for a given metaClass. Throws a RestAPIException if view not found

applyAttributesSecurity

public void applyAttributesSecurity(Entity entity)

By default entity is loaded from the middleware with the attributes that are not allowed for reading according to roles permissions. This methods removes attributes not allowed for the user.

Parameters:

entity - the entity. After the method is executed forbidden attributes will be cleaned.

transformEntityNameIfRequired

public java.lang.String transformEntityNameIfRequired(java.lang.String entityName,
                                                      java.lang.String modelVersion,
                                                      JsonTransformationDirection direction)

transformJsonIfRequired

public java.lang.String transformJsonIfRequired(java.lang.String entityName,
                                                java.lang.String modelVersion,
                                                JsonTransformationDirection direction,
                                                java.lang.String json)