Package io.jmix.messagetemplates.impl

Class MessageTemplatesGeneratorImpl

java.lang.Object

io.jmix.messagetemplates.impl.MessageTemplatesGeneratorImpl

All Implemented Interfaces:

MessageTemplatesGenerator, org.springframework.beans.factory.InitializingBean

@Component("msgtmp_MessageTemplatesImpl")
public class MessageTemplatesGeneratorImpl
extends Object
implements MessageTemplatesGenerator, org.springframework.beans.factory.InitializingBean

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	MessageTemplatesGeneratorImpl.MultiParamTemplateGeneratorImpl
class	MessageTemplatesGeneratorImpl.MultiTemplateGeneratorImpl
class	MessageTemplatesGeneratorImpl.SingleTemplateGeneratorImpl

Nested classes/interfaces inherited from interface io.jmix.messagetemplates.MessageTemplatesGenerator

MessageTemplatesGenerator.MultiParamTemplateGenerator, MessageTemplatesGenerator.MultiTemplateGenerator, MessageTemplatesGenerator.SingleTemplateGenerator

Field Summary

Fields

Modifier and Type	Field	Description
protected DataManager	dataManager
protected freemarker.template.Configuration	defaultConfiguration
protected freemarker.template.Version	version
protected freemarker.template.ObjectWrapper	wrapper

Constructor Summary

Constructors

Constructor	Description
MessageTemplatesGeneratorImpl(DataManager dataManager, MessageTemplateProperties messageTemplateProperties)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
String	generateMessage(MessageTemplate template, Map<String,Object> parameters)	Generates a message based on the passed MessageTemplate and parameters map.
String	generateMessage(String templateCode, Map<String,Object> parameters)	Generates a message based on the passed code of MessageTemplate and parameters map.
protected String	generateMessageInternal(MessageTemplate template, Map<String,Object> parameters, freemarker.template.Configuration configuration)
protected List<String>	generateMessagesByTemplates(Collection<MessageTemplate> templates, Map<String,Object> parameters, freemarker.template.Configuration configuration)
MessageTemplatesGenerator.MultiParamTemplateGenerator	generateMultiParamTemplate()	Creates MessageTemplatesGenerator.MultiParamTemplateGenerator.
MessageTemplatesGenerator.MultiTemplateGenerator	generateMultiTemplate()	Creates MessageTemplatesGenerator.MultiTemplateGenerator.
MessageTemplatesGenerator.SingleTemplateGenerator	generateSingleTemplate()	Creates MessageTemplatesGenerator.SingleTemplateGenerator.
protected freemarker.template.Template	getHtmlTemplate(MessageTemplate template, freemarker.template.Configuration configuration)
protected MessageTemplate	getMessageTemplateByCode(String templateCode)

Methods inherited from class java.lang.Object

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

Field Details

dataManager

protected DataManager dataManager

version

protected freemarker.template.Version version

wrapper

protected freemarker.template.ObjectWrapper wrapper

defaultConfiguration

protected freemarker.template.Configuration defaultConfiguration

Constructor Details

MessageTemplatesGeneratorImpl

public MessageTemplatesGeneratorImpl(DataManager dataManager,
 MessageTemplateProperties messageTemplateProperties)

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

generateSingleTemplate

public MessageTemplatesGenerator.SingleTemplateGenerator generateSingleTemplate()

Description copied from interface: MessageTemplatesGenerator

Creates MessageTemplatesGenerator.SingleTemplateGenerator.

The generator is used to create messages based on a single template and a single map of parameters. The result of the generation is a template filled with passed parameters.

Example of single template generation:

         generateSingleTemplate()
                 .withTemplateCode("my-template")
                 .addParam("username", "admin")
                 .addParam("firstName", "John")
                 .addParam("lastName", "Doe")
                 .generate();

 

Specified by:

generateSingleTemplate in interface MessageTemplatesGenerator

Returns:

MessageTemplatesGenerator.SingleTemplateGenerator

generateMultiTemplate

public MessageTemplatesGenerator.MultiTemplateGenerator generateMultiTemplate()

Description copied from interface: MessageTemplatesGenerator

Creates MessageTemplatesGenerator.MultiTemplateGenerator.

The generator is used to create messages based on a multiple set of templates and a single map of parameters. The result of the generation is a list of templates filled with passed parameters.

Example of multi template generation:

         generateMultiTemplate()
                 .withTemplateCodes("my-first-template", "my-second-template")
                 .addParam("username", "admin")
                 .addParam("firstName", "John")
                 .addParam("lastName", "Doe")
                 .generate();
 

Specified by:

generateMultiTemplate in interface MessageTemplatesGenerator

Returns:

MessageTemplatesGenerator.MultiTemplateGenerator

generateMultiParamTemplate

public MessageTemplatesGenerator.MultiParamTemplateGenerator generateMultiParamTemplate()

Description copied from interface: MessageTemplatesGenerator

Creates MessageTemplatesGenerator.MultiParamTemplateGenerator.

The generator is used to create messages based on a single template and multiple set of parameters. The result of the generation is a list of templates filled with different parameters.

Example of multi param template generation:

        generateMultiParamTemplate()
                 .withTemplateCode("my-template")
                 .addParams(Map.of(
                         "username", "admin",
                         "firstName", "John",
                         "lastName", "Doe"
                 ))
                 .addParams(Map.of(
                         "username", "user",
                         "firstName", "Mary",
                         "lastName", "Smith"
                 ))
                 .generate();
 

Specified by:

generateMultiParamTemplate in interface MessageTemplatesGenerator

Returns:

MessageTemplatesGenerator.MultiTemplateGenerator

generateMessage

public String generateMessage(MessageTemplate template,
 Map<String,Object> parameters)

Description copied from interface: MessageTemplatesGenerator

Generates a message based on the passed MessageTemplate and parameters map.

Specified by:

generateMessage in interface MessageTemplatesGenerator

Parameters:

template - template for generation

parameters - parameters for generation

Returns:

template filled with parameters

generateMessageInternal

protected String generateMessageInternal(MessageTemplate template,
 Map<String,Object> parameters,
 freemarker.template.Configuration configuration)

generateMessage

public String generateMessage(String templateCode,
 Map<String,Object> parameters)

Description copied from interface: MessageTemplatesGenerator

Generates a message based on the passed code of MessageTemplate and parameters map.

Specified by:

generateMessage in interface MessageTemplatesGenerator

Parameters:

templateCode - code of template for generation

parameters - parameters for generation

Returns:

template filled with parameters

generateMessagesByTemplates

protected List<String> generateMessagesByTemplates(Collection<MessageTemplate> templates,
 Map<String,Object> parameters,
 freemarker.template.Configuration configuration)

getMessageTemplateByCode

protected MessageTemplate getMessageTemplateByCode(String templateCode)

getHtmlTemplate

protected freemarker.template.Template getHtmlTemplate(MessageTemplate template,
 freemarker.template.Configuration configuration)