Package io.jmix.dynmodelflowui.impl

Class DynamicViewDeployer

java.lang.Object

io.jmix.dynmodelflowui.impl.DynamicViewDeployer

@Component("dynmod_DynamicViewDeployer")
public class DynamicViewDeployer
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	DynamicViewDeployer.DescriptorKind
protected static final record	DynamicViewDeployer.DynamicViewSignature
protected static final record	DynamicViewDeployer.MessageKey
protected static final record	DynamicViewDeployer.NormalizedDescriptorSignature

Field Summary

Fields

Modifier and Type	Field	Description
protected ClassManager	classManager
protected ComponentXmlFactory	componentXmlFactory
protected static final String	DEFAULT_EDITED_ENTITY_CONTAINER_ID
protected static final String	DEFAULT_LOOKUP_COMPONENT_ID
protected static final String	DEFAULT_TEMPLATE
protected final Set<DynamicViewDeployer.MessageKey>	deployedMessageKeys
protected final Map<String,DynamicViewDeployment>	deployedViews
protected ViewTemplateDescriptorRegistry	descriptorRegistry
protected static final String	DETAIL_TEMPLATE
protected static final String	DYNAMIC_DESCRIPTOR_ID_PREFIX
protected DynamicMessageStore	dynamicMessageStore
protected org.springframework.beans.factory.ObjectProvider<DynamicModelManager>	dynamicModelManagerProvider
protected DynamicModelPackageSupport	dynamicModelPackageSupport
protected DynamicModelTools	dynamicModelTools
protected static final Pattern	EDGE_SEPARATORS
protected freemarker.template.Configuration	freemarkerConfiguration
protected final Map<String,byte[]>	generatedClassBytes
protected static final String	LIST_TEMPLATE
protected MenuConfig	menuConfig
protected Metadata	metadata
protected MetadataGenerationManager	metadataGenerationManager
protected static final Pattern	NON_JAVA_IDENTIFIER_CHARS
protected static final Pattern	NON_ROUTE_CHARS
protected Resources	resources
protected DynamicModelSecuritySupport	securitySupport
protected ViewTemplateHelper	templateHelper
protected ViewRegistry	viewRegistry
protected ViewTemplateDefinitions	viewTemplateDefinitions

Constructor Summary

Constructors

Constructor	Description
DynamicViewDeployer()

Method Summary

Modifier and Type	Method	Description
protected void	addLocalizedMessages(String code, @Nullable Map<String,String> values)
protected Set<String>	collectCreatedDynamicEntities(DynamicModelDefinition modelDefinition)
protected net.bytebuddy.dynamic.DynamicType.Builder<? extends View<?>>	createControllerBuilder(String className, Class<? extends View<?>> superclass, String viewId, String descriptorPath, String route)
protected Class<? extends View<?>>	createControllerClass(String basePackage, String entityName, MetaClass metaClass, boolean dynamicEntity, DynamicViewType type, String viewId, String descriptorPath, @Nullable String route, DynamicViewDefinition definition, boolean primary)
protected List<DynamicViewDeployment>	createDeployments(DynamicModelDefinition modelDefinition, Session session)
protected Class<? extends View<?>>	createDynamicEntityControllerClass(String basePackage, String entityName, MetaClass metaClass, DynamicViewType type, String viewId, String descriptorPath, String route, DynamicViewDefinition definition, boolean primary)
protected freemarker.template.Configuration	createFreemarkerConfiguration()
protected String	createRouteSlug(String value)
protected @Nullable DynamicViewDeployer.DynamicViewSignature	createSignature(String entityName, boolean dynamicEntity, DynamicViewType type, String viewId, @Nullable String route, boolean primary, DynamicViewDefinition definition, @Nullable String title, @Nullable String menuTitle)
protected List<DynamicViewDeployer.DynamicViewSignature>	createSignatures(DynamicModelDefinition modelDefinition)
protected Class<? extends View<?>>	createStaticEntityControllerClass(MetaClass metaClass, String viewId, String descriptorPath)
protected String	defaultTemplatePath(DynamicViewType type)
void	deploy(DynamicViewDeployment deployment)
void	deployAll(Collection<DynamicViewDeployment> deployments)
protected boolean	deploymentsDiffer(@Nullable DynamicViewDeployment current, @Nullable DynamicViewDeployment next)
protected @Nullable Class<? extends View<?>>	findLoadedViewClass(String className)
List<String>	getChangedViews(DynamicModelDefinition modelDefinition)
Collection<DynamicViewDeployment>	getDeployedViews()
protected boolean	isDynamicEntity(String entityName, Set<String> createdDynamicEntities)
protected boolean	isDynamicStaticViewController(Class<? extends View<?>> controllerClass)
protected @Nullable Map<String,String>	localizedValues(@Nullable LocalizedValue value)
protected String	messageCode(String prefix, String id, String suffix)
protected DynamicViewDeployer.NormalizedDescriptorSignature	normalizeDescriptor(DynamicViewDefinition definition, boolean dynamicEntity, DynamicViewType type)
protected String	normalizeXmlDescriptorSource(String source)
void	onDynamicModelApplied(DynamicModelAppliedEvent event)
protected void	refreshMessages(Collection<DynamicViewDeployment> deployments)
protected void	registerDynamicPrimaryViews(Collection<DynamicViewDeployment> deployments)
protected String	renderTemplate(MetaClass metaClass, String templatePath, String title, Map<String,Object> templateParams)
void	reset()
protected String	resolveDescriptorSource(DynamicViewDefinition definition, MetaClass metaClass, boolean dynamicEntity, DynamicViewType type, String viewId)
protected String	resolveEditedEntityContainerId(DynamicViewDefinition definition)
protected String	resolveLookupComponentId(DynamicViewDefinition definition)
protected String	resolveMenuItemId(DynamicViewDefinition definition)
protected @Nullable String	resolveMenuTitle(DynamicViewDefinition definition, String title)
protected String	resolveRoute(DynamicViewDefinition definition, String viewId, DynamicViewType type)
protected Map<String,Object>	resolveTemplateParams(DynamicViewDefinition definition)
protected String	resolveTitle(String entityName, DynamicViewDefinition definition, DynamicViewType type)
protected DynamicViewType	resolveType(DynamicViewDefinition definition, MetaClass metaClass, boolean dynamicEntity)
protected DynamicViewType	resolveType(String entityName, DynamicViewDefinition definition, boolean dynamicEntity)
protected String	resolveViewId(String entityName, DynamicViewDefinition definition, DynamicViewType type)
protected boolean	signaturesDiffer(@Nullable DynamicViewDeployment current, @Nullable DynamicViewDeployer.DynamicViewSignature next)
protected String	toGeneratedClassNameSegment(String entityName)
protected void	undeploy(DynamicViewDeployment deployment, boolean removeClass)
protected Class<? extends View<?>>	unwrapDynamicStaticViewController(Class<? extends View<?>> controllerClass)
protected net.bytebuddy.description.annotation.AnnotationDescription	viewController(String viewId)
protected net.bytebuddy.description.annotation.AnnotationDescription	viewDescriptor(String descriptorPath)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_TEMPLATE

protected static final String DEFAULT_TEMPLATE

See Also:

• Constant Field Values

LIST_TEMPLATE

protected static final String LIST_TEMPLATE

See Also:

• Constant Field Values

DETAIL_TEMPLATE

protected static final String DETAIL_TEMPLATE

See Also:

• Constant Field Values

DEFAULT_LOOKUP_COMPONENT_ID

protected static final String DEFAULT_LOOKUP_COMPONENT_ID

See Also:

• Constant Field Values

DEFAULT_EDITED_ENTITY_CONTAINER_ID

protected static final String DEFAULT_EDITED_ENTITY_CONTAINER_ID

See Also:

• Constant Field Values

DYNAMIC_DESCRIPTOR_ID_PREFIX

protected static final String DYNAMIC_DESCRIPTOR_ID_PREFIX

See Also:

• Constant Field Values

NON_JAVA_IDENTIFIER_CHARS

protected static final Pattern NON_JAVA_IDENTIFIER_CHARS

NON_ROUTE_CHARS

protected static final Pattern NON_ROUTE_CHARS

EDGE_SEPARATORS

protected static final Pattern EDGE_SEPARATORS

metadata

@Autowired
protected Metadata metadata

metadataGenerationManager

@Autowired
protected MetadataGenerationManager metadataGenerationManager

resources

@Autowired
protected Resources resources

classManager

@Autowired
protected ClassManager classManager

viewRegistry

@Autowired
protected ViewRegistry viewRegistry

descriptorRegistry

@Autowired
protected ViewTemplateDescriptorRegistry descriptorRegistry

viewTemplateDefinitions

@Autowired
protected ViewTemplateDefinitions viewTemplateDefinitions

componentXmlFactory

@Autowired
protected ComponentXmlFactory componentXmlFactory

templateHelper

@Autowired
protected ViewTemplateHelper templateHelper

dynamicModelTools

@Autowired
protected DynamicModelTools dynamicModelTools

dynamicModelPackageSupport

@Autowired
protected DynamicModelPackageSupport dynamicModelPackageSupport

dynamicModelManagerProvider

@Autowired
protected org.springframework.beans.factory.ObjectProvider<DynamicModelManager> dynamicModelManagerProvider

dynamicMessageStore

@Autowired
protected DynamicMessageStore dynamicMessageStore

menuConfig

@Autowired
protected MenuConfig menuConfig

securitySupport

@Autowired
protected DynamicModelSecuritySupport securitySupport

freemarkerConfiguration

protected freemarker.template.Configuration freemarkerConfiguration

deployedViews

protected final Map<String,DynamicViewDeployment> deployedViews

generatedClassBytes

protected final Map<String,byte[]> generatedClassBytes

deployedMessageKeys

protected final Set<DynamicViewDeployer.MessageKey> deployedMessageKeys

Constructor Details

DynamicViewDeployer

public DynamicViewDeployer()

Method Details

getDeployedViews

public Collection<DynamicViewDeployment> getDeployedViews()

reset

public void reset()

getChangedViews

public List<String> getChangedViews(DynamicModelDefinition modelDefinition)

onDynamicModelApplied

@EventListener
public void onDynamicModelApplied(DynamicModelAppliedEvent event)

deployAll

public void deployAll(Collection<DynamicViewDeployment> deployments)

deploymentsDiffer

protected boolean deploymentsDiffer(@Nullable DynamicViewDeployment current,
 @Nullable DynamicViewDeployment next)

deploy

public void deploy(DynamicViewDeployment deployment)

undeploy

protected void undeploy(DynamicViewDeployment deployment,
 boolean removeClass)

createDeployments

protected List<DynamicViewDeployment> createDeployments(DynamicModelDefinition modelDefinition,
 Session session)

createSignatures

protected List<DynamicViewDeployer.DynamicViewSignature> createSignatures(DynamicModelDefinition modelDefinition)

createControllerClass

protected Class<? extends View<?>> createControllerClass(String basePackage,
 String entityName,
 MetaClass metaClass,
 boolean dynamicEntity,
 DynamicViewType type,
 String viewId,
 String descriptorPath,
 @Nullable String route,
 DynamicViewDefinition definition,
 boolean primary)

createDynamicEntityControllerClass

protected Class<? extends View<?>> createDynamicEntityControllerClass(String basePackage,
 String entityName,
 MetaClass metaClass,
 DynamicViewType type,
 String viewId,
 String descriptorPath,
 String route,
 DynamicViewDefinition definition,
 boolean primary)

createStaticEntityControllerClass

protected Class<? extends View<?>> createStaticEntityControllerClass(MetaClass metaClass,
 String viewId,
 String descriptorPath)

createControllerBuilder

protected net.bytebuddy.dynamic.DynamicType.Builder<? extends View<?>> createControllerBuilder(String className,
 Class<? extends View<?>> superclass,
 String viewId,
 String descriptorPath,
 String route)

viewController

protected net.bytebuddy.description.annotation.AnnotationDescription viewController(String viewId)

viewDescriptor

protected net.bytebuddy.description.annotation.AnnotationDescription viewDescriptor(String descriptorPath)

resolveDescriptorSource

protected String resolveDescriptorSource(DynamicViewDefinition definition,
 MetaClass metaClass,
 boolean dynamicEntity,
 DynamicViewType type,
 String viewId)

unwrapDynamicStaticViewController

protected Class<? extends View<?>> unwrapDynamicStaticViewController(Class<? extends View<?>> controllerClass)

isDynamicStaticViewController

protected boolean isDynamicStaticViewController(Class<? extends View<?>> controllerClass)

renderTemplate

protected String renderTemplate(MetaClass metaClass,
 String templatePath,
 String title,
 Map<String,Object> templateParams)

resolveType

protected DynamicViewType resolveType(DynamicViewDefinition definition,
 MetaClass metaClass,
 boolean dynamicEntity)

resolveType

protected DynamicViewType resolveType(String entityName,
 DynamicViewDefinition definition,
 boolean dynamicEntity)

resolveViewId

protected String resolveViewId(String entityName,
 DynamicViewDefinition definition,
 DynamicViewType type)

resolveRoute

protected String resolveRoute(DynamicViewDefinition definition,
 String viewId,
 DynamicViewType type)

resolveTitle

protected String resolveTitle(String entityName,
 DynamicViewDefinition definition,
 DynamicViewType type)

resolveMenuTitle

protected @Nullable String resolveMenuTitle(DynamicViewDefinition definition,
 String title)

resolveTemplateParams

protected Map<String,Object> resolveTemplateParams(DynamicViewDefinition definition)

localizedValues

protected @Nullable Map<String,String> localizedValues(@Nullable LocalizedValue value)

resolveLookupComponentId

protected String resolveLookupComponentId(DynamicViewDefinition definition)

resolveEditedEntityContainerId

protected String resolveEditedEntityContainerId(DynamicViewDefinition definition)

defaultTemplatePath

protected String defaultTemplatePath(DynamicViewType type)

createRouteSlug

protected String createRouteSlug(String value)

toGeneratedClassNameSegment

protected String toGeneratedClassNameSegment(String entityName)

refreshMessages

protected void refreshMessages(Collection<DynamicViewDeployment> deployments)

addLocalizedMessages

protected void addLocalizedMessages(String code,
 @Nullable Map<String,String> values)

registerDynamicPrimaryViews

protected void registerDynamicPrimaryViews(Collection<DynamicViewDeployment> deployments)

messageCode

protected String messageCode(String prefix,
 String id,
 String suffix)

resolveMenuItemId

protected String resolveMenuItemId(DynamicViewDefinition definition)

signaturesDiffer

protected boolean signaturesDiffer(@Nullable DynamicViewDeployment current,
 @Nullable DynamicViewDeployer.DynamicViewSignature next)

createSignature

protected @Nullable DynamicViewDeployer.DynamicViewSignature createSignature(String entityName,
 boolean dynamicEntity,
 DynamicViewType type,
 String viewId,
 @Nullable String route,
 boolean primary,
 DynamicViewDefinition definition,
 @Nullable String title,
 @Nullable String menuTitle)

normalizeDescriptor

protected DynamicViewDeployer.NormalizedDescriptorSignature normalizeDescriptor(DynamicViewDefinition definition,
 boolean dynamicEntity,
 DynamicViewType type)

normalizeXmlDescriptorSource

protected String normalizeXmlDescriptorSource(String source)

isDynamicEntity

protected boolean isDynamicEntity(String entityName,
 Set<String> createdDynamicEntities)

collectCreatedDynamicEntities

protected Set<String> collectCreatedDynamicEntities(DynamicModelDefinition modelDefinition)

createFreemarkerConfiguration

protected freemarker.template.Configuration createFreemarkerConfiguration()

findLoadedViewClass

protected @Nullable Class<? extends View<?>> findLoadedViewClass(String className)