fr.sii.ogham.template.thymeleaf.buider.AbstractThymeleafBuilder Maven / Gradle / Ivy
Show all versions of ogham-template-thymeleaf Show documentation
package fr.sii.ogham.template.thymeleaf.buider;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.thymeleaf.TemplateEngine;
import org.thymeleaf.templateresolver.ITemplateResolver;
import fr.sii.ogham.core.builder.AbstractParent;
import fr.sii.ogham.core.builder.Builder;
import fr.sii.ogham.core.builder.env.EnvironmentBuilder;
import fr.sii.ogham.core.builder.env.EnvironmentBuilderDelegate;
import fr.sii.ogham.core.builder.env.SimpleEnvironmentBuilder;
import fr.sii.ogham.core.builder.resolution.ClassPathResolutionBuilder;
import fr.sii.ogham.core.builder.resolution.FileResolutionBuilder;
import fr.sii.ogham.core.builder.resolution.ResourceResolutionBuilder;
import fr.sii.ogham.core.builder.resolution.ResourceResolutionBuilderHelper;
import fr.sii.ogham.core.builder.resolution.StringResolutionBuilder;
import fr.sii.ogham.core.builder.template.DetectorBuilder;
import fr.sii.ogham.core.resource.resolver.FirstSupportingResourceResolver;
import fr.sii.ogham.core.resource.resolver.ResourceResolver;
import fr.sii.ogham.core.template.detector.TemplateEngineDetector;
import fr.sii.ogham.core.template.parser.TemplateParser;
import fr.sii.ogham.template.thymeleaf.SimpleThymeleafContextConverter;
import fr.sii.ogham.template.thymeleaf.TemplateResolverOptions;
import fr.sii.ogham.template.thymeleaf.ThymeLeafFirstSupportingTemplateResolver;
import fr.sii.ogham.template.thymeleaf.ThymeleafContextConverter;
import fr.sii.ogham.template.thymeleaf.ThymeleafParser;
import fr.sii.ogham.template.thymeleaf.ThymeleafTemplateDetector;
import fr.sii.ogham.template.thymeleaf.adapter.ClassPathResolverAdapter;
import fr.sii.ogham.template.thymeleaf.adapter.FileResolverAdapter;
import fr.sii.ogham.template.thymeleaf.adapter.FirstSupportingResolverAdapter;
import fr.sii.ogham.template.thymeleaf.adapter.StringResolverAdapter;
import fr.sii.ogham.template.thymeleaf.adapter.TemplateResolverAdapter;
import fr.sii.ogham.template.thymeleaf.configure.DefaultThymeleafEmailConfigurer;
public abstract class AbstractThymeleafBuilder, P> extends AbstractParent
implements DetectorBuilder, ResourceResolutionBuilder, Builder {
private static final Logger LOG = LoggerFactory.getLogger(AbstractThymeleafBuilder.class);
protected MYSELF myself;
protected EnvironmentBuilder environmentBuilder;
private TemplateEngineDetector detector;
private ResourceResolutionBuilderHelper resourceResolutionBuilderHelper;
private TemplateEngine engine;
private ThymeleafContextConverter contextConverter;
private ThymeleafEngineConfigBuilder engineBuilder;
private List customAdapters;
protected AbstractThymeleafBuilder(Class selfType) {
this(selfType, null, null);
}
@SuppressWarnings("unchecked")
protected AbstractThymeleafBuilder(Class selfType, P parent, EnvironmentBuilder environmentBuilder) {
super(parent);
myself = (MYSELF) selfType.cast(this);
if (environmentBuilder != null) {
environment(environmentBuilder);
}
customAdapters = new ArrayList<>();
}
protected AbstractThymeleafBuilder(P parent, EnvironmentBuilder environmentBuilder) {
this(AbstractThymeleafBuilder.class, parent, environmentBuilder);
}
/**
* Configures environment for the builder (and sub-builders). Environment
* consists of configuration properties/values that are used to configure
* the system (see {@link EnvironmentBuilder} for more information).
*
* You can use system properties:
*
*
* .environment()
* .systemProperties();
*
*
* Or, you can load properties from a file:
*
*
* .environment()
* .properties("/path/to/file.properties")
*
*
* Or using directly a {@link Properties} object:
*
*
* Properties myprops = new Properties();
* myprops.setProperty("foo", "bar");
* .environment()
* .properties(myprops)
*
*
* Or defining directly properties:
*
*
* .environment()
* .properties()
* .set("foo", "bar")
*
*
*
*
* If no environment was previously used, it creates a new one. Then each
* time you call {@link #environment()}, the same instance is used.
*
*
* @return the builder to configure properties handling
*/
public EnvironmentBuilder environment() {
if (environmentBuilder == null) {
environmentBuilder = new SimpleEnvironmentBuilder<>(myself);
}
return environmentBuilder;
}
/**
* NOTE: this is mostly for advance usage (when creating a custom module).
*
* Inherits environment configuration from another builder. This is useful
* for configuring independently different parts of Ogham but keeping a
* whole coherence (see {@link DefaultThymeleafEmailConfigurer} for an
* example of use).
*
* The same instance is shared meaning that all changes done here will also
* impact the other builder.
*
*
* If a previous builder was defined (by calling {@link #environment()} for
* example), the new builder will override it.
*
* @param builder
* the builder to inherit
* @return this instance for fluent chaining
*/
public MYSELF environment(EnvironmentBuilder builder) {
environmentBuilder = new EnvironmentBuilderDelegate<>(myself, builder);
return myself;
}
/**
* Fluent configurer for Thymeleaf engine configuration.
*
* @return the fluent builder for Thymeleaf engine
*/
public ThymeleafEngineConfigBuilder engine() {
if (engineBuilder == null) {
engineBuilder = new ThymeleafEngineConfigBuilder<>(myself);
}
return engineBuilder;
}
/**
* Sets a Thymeleaf engine.
*
* This value preempts any other value defined by calling {@link #engine()}
* method.
*
* If this method is called several times, only the last provider is used.
*
* @param engine
* the Thymeleaf engine
* @return this instance for fluent chaining
*/
public MYSELF engine(TemplateEngine engine) {
this.engine = engine;
return myself;
}
/**
* Ogham provides a generic context concept for template parsing. Thymeleaf
* uses also a context concept. A context converter
* ({@link ThymeleafContextConverter}) is the way to transform an Ogham
* context into a Thymeleaf context.
*
*
* Ogham provides and registers the default converter
*
*
* If this method is called several times, only the last provider is used.
*
* @param converter
* the context converter
* @return this instance for fluent chaining
*/
public MYSELF contextConverter(ThymeleafContextConverter converter) {
this.contextConverter = converter;
return myself;
}
@Override
public MYSELF detector(TemplateEngineDetector detector) {
this.detector = detector;
return myself;
}
@Override
public ClassPathResolutionBuilder classpath() {
initResolutionBuilder();
return resourceResolutionBuilderHelper.classpath();
}
@Override
public FileResolutionBuilder file() {
initResolutionBuilder();
return resourceResolutionBuilderHelper.file();
}
@Override
public StringResolutionBuilder string() {
initResolutionBuilder();
return resourceResolutionBuilderHelper.string();
}
@Override
public MYSELF resolver(ResourceResolver resolver) {
initResolutionBuilder();
return resourceResolutionBuilderHelper.resolver(resolver);
}
/**
* Ogham provides a generic resource resolution mechanism
* ({@link ResourceResolver}). Thymeleaf uses its own template resolution
* mechanism ({@link ITemplateResolver}). A resolver adapter
* ({@link TemplateResolverAdapter}) is the way to transform a
* {@link ResourceResolver} into a {@link ITemplateResolver}.
*
*
* Ogham provides and registers default resolver adapters but you may need
* to use a custom {@link ResourceResolver}. So you also need to provide the
* corresponding {@link TemplateResolverAdapter}.
*
* @param adapter
* the resolver adapter
* @return this instance for fluent chaining
*/
public MYSELF resolverAdapter(TemplateResolverAdapter adapter) {
customAdapters.add(adapter);
return myself;
}
@Override
public TemplateParser build() {
LOG.info("Thymeleaf parser is registered");
return new ThymeleafParser(buildEngine(), buildContext());
}
@Override
public TemplateEngineDetector buildDetector() {
return detector == null ? new ThymeleafTemplateDetector(buildResolver()) : detector;
}
/**
* Builds the resolver used by Thymeleaf to resolve resources
*
* @return the resource resolver
*/
public FirstSupportingResourceResolver buildResolver() {
return new FirstSupportingResourceResolver(buildResolvers());
}
protected TemplateEngine buildEngine() {
TemplateEngine builtEngine;
if (this.engine != null) {
LOG.debug("Using custom Thymeleaf engine");
builtEngine = this.engine;
} else if (engineBuilder != null) {
LOG.debug("Using custom Thymeleaf engine built using engine()");
builtEngine = engineBuilder.build();
} else {
LOG.debug("Using default Thymeleaf engine");
builtEngine = new TemplateEngine();
}
builtEngine.addTemplateResolver(new ThymeLeafFirstSupportingTemplateResolver(buildResolver(), buildAdapters()));
return builtEngine;
}
protected ThymeleafContextConverter buildContext() {
return contextConverter == null ? new SimpleThymeleafContextConverter() : contextConverter;
}
private List buildResolvers() {
return resourceResolutionBuilderHelper.buildResolvers();
}
protected FirstSupportingResolverAdapter buildAdapters() {
FirstSupportingResolverAdapter adapter = new FirstSupportingResolverAdapter();
for (TemplateResolverAdapter custom : customAdapters) {
adapter.addAdapter(custom);
}
adapter.addAdapter(new ClassPathResolverAdapter());
adapter.addAdapter(new FileResolverAdapter());
adapter.addAdapter(new StringResolverAdapter());
adapter.setOptions(new TemplateResolverOptions());
return adapter;
}
private void initResolutionBuilder() {
if (resourceResolutionBuilderHelper == null) {
resourceResolutionBuilderHelper = new ResourceResolutionBuilderHelper<>(myself, environmentBuilder);
}
}
}