Package io.jmix.reportsrest.controller

Class ReportRestControllerManager

java.lang.Object

io.jmix.reportsrest.controller.ReportRestControllerManager

@Component("report_ReportRestControllerManager")
public class ReportRestControllerManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ReportRestControllerManager.GroupInfo
protected static class	ReportRestControllerManager.InputParameterInfo
protected static class	ReportRestControllerManager.ParameterValueInfo
protected static class	ReportRestControllerManager.ReportInfo
protected static class	ReportRestControllerManager.ReportRunRestBody
protected static class	ReportRestControllerManager.TemplateInfo

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserSubstitution	currentUserSubstitution
protected DataManager	dataManager
protected EntityStates	entityStates
protected Metadata	metadata
protected MetadataTools	metadataTools
protected ObjectToStringConverter	objectToStringConverter
protected ParameterClassResolver	parameterClassResolver
protected PolicyStore	policyStore
protected ReportGroupRepository	reportGroupRepository
protected ReportInputParameterValidator	reportInputParameterValidator
protected ReportRepository	reportRepository
protected ReportRunner	reportRunner
protected SecureOperations	secureOperations

Constructor Summary

Constructors

Constructor	Description
ReportRestControllerManager()

Method Summary

Modifier and Type	Method	Description
protected void	checkCanReadEntity(MetaClass metaClass)
protected void	checkEntityIsNotNull(String entityName, String entityId, @Nullable Object entity)
protected void	checkEntityIsNotNull(String entityName, String identifierName, String identifierValue, @Nullable Object entity)
protected void	checkReportOutputType(ReportTemplate reportTemplate)
protected Map<String,Object>	collectValuesToValidate(Report report, @Nullable List<ReportRestControllerManager.ParameterValueInfo> paramValues, Map<String,Object> preparedValues)	Collects the values to validate, in the canonical parameter class the UI and the reporting engine use: a passed scalar is parsed from its string value into that class (not the java.sql.* wire class used to run the report); a passed entity reuses the instance already loaded for the run; a parameter the caller did not pass falls back to its default value.
protected com.google.gson.Gson	createGson()
protected @Nullable Report	findAccessibleReportByCode(String code)
protected @Nullable Report	findAccessibleReportById(UUID reportId)
protected @Nullable ReportGroup	findReportGroupById(UUID groupId)
protected Object	getIdFromString(String entityId, MetaClass metaClass)
protected UUID	getReportGroupIdFromString(String entityId)
protected UUID	getReportIdFromString(String entityId)
protected List<Report>	loadAccessibleReports()
String	loadGroup(String entityId)
String	loadReport(String entityId)
protected Report	loadReportByCodeInternal(String code)
protected Report	loadReportInternal(String entityId)
String	loadReportsList()
protected ReportRestControllerManager.InputParameterInfo	mapInputParameterInfo(ReportInputParameter parameter)
protected ReportRestControllerManager.TemplateInfo	mapTemplateInfo(ReportTemplate template)
protected ReportRestControllerManager.ReportInfo	mapToReportInfo(Report report)
protected @Nullable Object	prepareValue(ReportInputParameter inputParam, ReportRestControllerManager.ParameterValueInfo paramValue)
protected Map<String,Object>	prepareValues(Report report, List<ReportRestControllerManager.ParameterValueInfo> paramValues)
protected Class	resolveDatatypeActualClass(ReportInputParameter inputParam)
protected @Nullable Object	resolveDefaultValue(ReportInputParameter inputParameter)
protected @Nullable Object	resolveValueToValidate(ReportInputParameter inputParameter, @Nullable List<ReportRestControllerManager.ParameterValueInfo> paramValues, Map<String,Object> preparedValues)
ReportRestResult	runReport(String entityId, String bodyJson)
ReportRestResult	runReportByCode(String code, String bodyJson)
protected ReportRestResult	runReportInternal(Report report, String bodyJson, String reportRef)
protected String	transformDefaultValue(ReportInputParameter parameter)
protected void	validateReportParameters(Report report, @Nullable List<ReportRestControllerManager.ParameterValueInfo> paramValues, Map<String,Object> preparedValues)	Validates report input parameters the same way the UI does before running: single-parameter validators (delegate and Groovy script) for parameters with validation turned on, then report-level cross-parameter validation.

Methods inherited from class java.lang.Object

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

Field Details

dataManager

@Autowired
protected DataManager dataManager

reportRepository

@Autowired
protected ReportRepository reportRepository

reportGroupRepository

@Autowired
protected ReportGroupRepository reportGroupRepository

reportRunner

@Autowired
protected ReportRunner reportRunner

reportInputParameterValidator

@Autowired
protected ReportInputParameterValidator reportInputParameterValidator

objectToStringConverter

@Autowired
protected ObjectToStringConverter objectToStringConverter

metadata

@Autowired
protected Metadata metadata

metadataTools

@Autowired
protected MetadataTools metadataTools

entityStates

@Autowired
protected EntityStates entityStates

secureOperations

@Autowired
protected SecureOperations secureOperations

parameterClassResolver

@Autowired
protected ParameterClassResolver parameterClassResolver

policyStore

@Autowired
protected PolicyStore policyStore

currentUserSubstitution

@Autowired
protected CurrentUserSubstitution currentUserSubstitution

Constructor Details

ReportRestControllerManager

public ReportRestControllerManager()

Method Details

loadGroup

public String loadGroup(String entityId)

loadReportsList

public String loadReportsList()

loadReport

public String loadReport(String entityId)

runReport

public ReportRestResult runReport(String entityId,
 String bodyJson)

runReportByCode

public ReportRestResult runReportByCode(String code,
 String bodyJson)

runReportInternal

protected ReportRestResult runReportInternal(Report report,
 String bodyJson,
 String reportRef)

loadReportInternal

protected Report loadReportInternal(String entityId)

loadReportByCodeInternal

protected Report loadReportByCodeInternal(String code)

validateReportParameters

protected void validateReportParameters(Report report,
 @Nullable List<ReportRestControllerManager.ParameterValueInfo> paramValues,
 Map<String,Object> preparedValues)

Validates report input parameters the same way the UI does before running: single-parameter validators (delegate and Groovy script) for parameters with validation turned on, then report-level cross-parameter validation. Values are validated in the canonical parameter class (e.g. LocalDate) - the type the UI and the reporting engine use - and include default values of parameters the caller did not pass. A ReportParametersValidationException thrown here is translated into a 400 Bad Request response by the caller instead of running the report with invalid input. The report itself still runs with preparedValues; the collected values are used for validation only.

collectValuesToValidate

protected Map<String,Object> collectValuesToValidate(Report report,
 @Nullable List<ReportRestControllerManager.ParameterValueInfo> paramValues,
 Map<String,Object> preparedValues)

Collects the values to validate, in the canonical parameter class the UI and the reporting engine use: a passed scalar is parsed from its string value into that class (not the java.sql.* wire class used to run the report); a passed entity reuses the instance already loaded for the run; a parameter the caller did not pass falls back to its default value. This mirrors what the UI validates and keeps typed validator delegates from receiving an unexpected value type.

resolveValueToValidate

protected @Nullable Object resolveValueToValidate(ReportInputParameter inputParameter,
 @Nullable List<ReportRestControllerManager.ParameterValueInfo> paramValues,
 Map<String,Object> preparedValues)

resolveDefaultValue

protected @Nullable Object resolveDefaultValue(ReportInputParameter inputParameter)

prepareValues

protected Map<String,Object> prepareValues(Report report,
 List<ReportRestControllerManager.ParameterValueInfo> paramValues)

createGson

protected com.google.gson.Gson createGson()

prepareValue

protected @Nullable Object prepareValue(ReportInputParameter inputParam,
 ReportRestControllerManager.ParameterValueInfo paramValue)

resolveDatatypeActualClass

protected Class resolveDatatypeActualClass(ReportInputParameter inputParam)

mapToReportInfo

protected ReportRestControllerManager.ReportInfo mapToReportInfo(Report report)

mapTemplateInfo

protected ReportRestControllerManager.TemplateInfo mapTemplateInfo(ReportTemplate template)

mapInputParameterInfo

protected ReportRestControllerManager.InputParameterInfo mapInputParameterInfo(ReportInputParameter parameter)

transformDefaultValue

protected String transformDefaultValue(ReportInputParameter parameter)

getReportIdFromString

protected UUID getReportIdFromString(String entityId)

getReportGroupIdFromString

protected UUID getReportGroupIdFromString(String entityId)

loadAccessibleReports

protected List<Report> loadAccessibleReports()

findAccessibleReportById

protected @Nullable Report findAccessibleReportById(UUID reportId)

findAccessibleReportByCode

protected @Nullable Report findAccessibleReportByCode(String code)

findReportGroupById

protected @Nullable ReportGroup findReportGroupById(UUID groupId)

getIdFromString

protected Object getIdFromString(String entityId,
 MetaClass metaClass)

checkCanReadEntity

protected void checkCanReadEntity(MetaClass metaClass)

checkEntityIsNotNull

protected void checkEntityIsNotNull(String entityName,
 String entityId,
 @Nullable Object entity)

checkEntityIsNotNull

protected void checkEntityIsNotNull(String entityName,
 String identifierName,
 String identifierValue,
 @Nullable Object entity)

checkReportOutputType

protected void checkReportOutputType(ReportTemplate reportTemplate)