Module io.jstach.opt.spring.boot.webmvc

Package io.jstach.opt.spring.boot.webmvc

Class JStachioConfiguration

java.lang.Object

io.jstach.opt.spring.boot.webmvc.JStachioConfiguration

@Configuration
@EnableConfigurationProperties(JStachioProperties.class)
public class JStachioConfiguration
extends Object

Configures JStachio Spring style.

Templates are loaded from the ServiceLoader and are then registered in the ApplicationContext. Extensions that are wired by Spring will also be discovered as well as ServiceLoader based extensions that are not already wired as beans.

Author:

agentgt, dsyer

API Note

while this class and methods on this class are public for Spring reflection it is not intended to be true public API.

Constructor Summary

Constructors

Constructor	Description
JStachioConfiguration(ConfigurableListableBeanFactory beanFactory)	Do nothing constructor to placate jdk 18 javadoc

Method Summary

Modifier and Type	Method	Description
JStachioConfig	config(Environment environment)	Resolve config from spring environment
SpringJStachio	jstachio(List<JStachioExtension> extensions)	Creates jstachio from found plugins
JStachioHttpMessageConverter	messageConverter(JStachio jstachio, JStachioProperties properties)	Creates a message converter from Spring JStachio
SpringJStachioExtension	springJStachioExtension(JStachioConfig config, JStachioTemplateFinder templateFinder)	Creates a services based on spring objects.
TemplateConfig	templateConfig()	The default template config is empty and will let each template resolve its own config.
JStachioTemplateFinder	templateFinder(JStachioConfig config, TemplateConfig templateConfig)	Resolve template finder configs
List<Template<?>>	templatesByServiceLoader(TemplateConfig templateConfig)	Templates found with the service loader

Methods inherited from class java.lang.Object

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

Constructor Details

JStachioConfiguration

public JStachioConfiguration(ConfigurableListableBeanFactory beanFactory)

Do nothing constructor to placate jdk 18 javadoc

Parameters:

beanFactory - used to register the serviceloader found templates

Method Details

templatesByServiceLoader

@Bean
public List<Template<?>> templatesByServiceLoader(TemplateConfig templateConfig)

Templates found with the service loader

Parameters:

templateConfig - used to create singleton templates

Returns:

templates

See Also:

• templateConfig()

config

@Bean
@ConditionalOnMissingBean(JStachioConfig.class)
public JStachioConfig config(Environment environment)

Resolve config from spring environment

Parameters:

environment - for properties

Returns:

config

templateFinder

@Bean
@ConditionalOnMissingBean(JStachioTemplateFinder.class)
public JStachioTemplateFinder templateFinder(JStachioConfig config,
 TemplateConfig templateConfig)

Resolve template finder configs

Parameters:

config - jstachio config

templateConfig - the template config

Returns:

spring powered template finder

templateConfig

@Bean
@ConditionalOnMissingBean(TemplateConfig.class)
public TemplateConfig templateConfig()

The default template config is empty and will let each template resolve its own config. The template config contains an optional formatter (nullable) and optional escaper (nullable). If a template config is provided as a bean somewhere else it will replace this default. The only time this could be of use is if you needed a formatter or escaper with custom wiring.

Returns:

empty template config.

See Also:

• TemplateConfig.empty()

springJStachioExtension

@Bean
public SpringJStachioExtension springJStachioExtension(JStachioConfig config,
 JStachioTemplateFinder templateFinder)

Creates a services based on spring objects.

Parameters:

config - used for config

templateFinder - used to find templates

Returns:

spring powered jstatchio extension provider

See Also:

• TemplateConfig.empty()

jstachio

@Bean
@ConditionalOnMissingBean(JStachio.class)
public SpringJStachio jstachio(List<JStachioExtension> extensions)

Creates jstachio from found plugins

Parameters:

extensions - plugins

Returns:

spring version fo jstachio

messageConverter

@Bean
@ConditionalOnMissingBean(JStachioHttpMessageConverter.class)
public JStachioHttpMessageConverter messageConverter(JStachio jstachio,
 JStachioProperties properties)

Creates a message converter from Spring JStachio

Parameters:

jstachio - jstachio instance

properties - spring boot powered properties

Returns:

jstachio message converter