https://github.com/andrehertwig/spring-boot-starter-velocity2

Spring-Boot auto configuration for Velocity 2.0 Template Engine
https://github.com/andrehertwig/spring-boot-starter-velocity2

apache-velocity spring-boot spring-boot-starter template-engine

Last synced: 4 days ago
JSON representation

Spring-Boot auto configuration for Velocity 2.0 Template Engine

• Host: GitHub
• URL: https://github.com/andrehertwig/spring-boot-starter-velocity2
• Owner: andrehertwig
• License: apache-2.0
• Created: 2017-11-30T18:52:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-08T15:34:23.000Z (over 5 years ago)
• Last Synced: 2024-11-15T05:57:15.010Z (4 days ago)
• Topics: apache-velocity, spring-boot, spring-boot-starter, template-engine
• Language: Java
• Size: 23.4 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Spring-Boot auto configuration for Velocity 2.0 Template Engine

> Just a Spring-Boot starter for Velocity 2.0 Template Engine.

This starter just appends the [Velocity Engine 2.0](http://velocity.apache.org/engine/2.0/) to Spring context and you can configure it via spring properties.

Because Velocity-Tools is still in version 2.0 and incompatible to Velocity-Template-Engine 2.0 there is no implmentation for tools.

Furthermore this starter does not provide any ViewResolver.

[![Maven Central](https://img.shields.io/maven-central/v/de.chandre.velocity2/spring-boot-starter-velocity2.svg)](https://mvnrepository.com/artifact/de.chandre.velocity2)

[![GitHub issues](https://img.shields.io/github/issues/andrehertwig/spring-boot-starter-velocity2.svg)](https://github.com/andrehertwig/spring-boot-starter-velocity2/issues)

[![license](https://img.shields.io/github/license/andrehertwig/spring-boot-starter-velocity2.svg)](https://github.com/andrehertwig/spring-boot-starter-velocity2/blob/develop/LICENSE)

This is just a spare-time project. The usage of this tool (especially in production systems) is at your own risk.

# Content

1. [Requirements, Dependencies](#requirements-dependencies)

2. [Usage](#usage)

3. [Configuration Properties](#configuration-properties)

4. [Additional Things](#additional-things)

## Requirements, Dependencies

* spring-boot

* apache velocity 2.0

* apache velocity tools 3.0 (optional)

Unit-Tested with Spring Boot 1.5.6, 1.5.19

## Usage

```xml

	de.chandre.velocity2

	spring-boot-starter-velocity2

	1.1.0

	

```

Maybe you have to explicitly enable the component scan for the package:

```java

@SpringBootApplication

@EnableAutoConfiguration

@ComponentScan(basePackages={"your.packages", "de.chandre.velocity2.spring"})

public class MyBootApplication {

 

}

```

## Configuration Properties

For special configuration, please check the [additional-spring-configuration-metadata.json](src/main/resources/META-INF/additional-spring-configuration-metadata.json) 

## Additional Things

If you want to add velocity properties at runtime while application start-up, you are able to do that by implementing the `de.chandre.velocity2.spring.Velocity2PropertiesOverrideHook`.

Example:

```java

@Configuration

@AutoConfigureBefore(Velocity2AutoConfiguration.class)

public class VelocityConfig

{

	private static final Logger LOGGER = LogManager.getFormatterLogger(VelocityConfig.class);

	

	@Bean

	public Velocity2PropertiesOverrideHook velocity2PropertiesOverrideHook(MyResourceManager rcMgr) {

		return new Velocity2PropertiesOverrideHook() {

			@Override

			public Properties override(Properties velocityProperties) {

				velocityProperties.put(RuntimeConstants.RESOURCE_MANAGER_INSTANCE, rcMgr);

				return velocityProperties;

			}

		};

	}

}

```