Skip to content
ZK - Spring Boot integration
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
zkspringboot-autoconfig upgrade ZK version Nov 30, 2018
zkspringboot-demos issue-14: add font resource path exception in security demo May 3, 2019
zkspringboot-starter upgrade ZK version Nov 30, 2018
.gitignore
LICENSE Initial commit Aug 20, 2018
README.md Update README.md Oct 30, 2018
pom.xml move zats tests into autoconfig project Sep 4, 2018
prepare-upload.sh adjust release scripts Aug 31, 2018
release adjust build scripts Sep 4, 2018
upVer adjust build scripts Sep 4, 2018
version prepare 1.0.4 Nov 14, 2018

README.md

ZK - Spring Boot

License

(Adapted from Dirk's amazing zk-spring-boot-starter - Thanks a lot for the input and ideas!)

Getting started

Configuration options (for Spring Boot style application.properties)

Defaults as in ZkProperties.java

zk.springboot-packaging=jar

zk.homepage=
zk.zul-view-resolver-enabled=true
zk.zul-view-resolver-prefix=
zk.zul-view-resolver-suffix=.zul

zk.richlet-filter-mapping=

zk.websockets-enabled=true
zk.servlet3-push-enabled=true
zk.update-uri=/zkau
property default example(s) description
zk.springboot-packaging jar war/jar package as jar or war file
zk.homepage empty home/main when set will setup a @GetMapping for "/" to return the configured view-name
zk.zul-view-resolver-enabled true true/false enable/disable InternalViewResolver for zul files
zk.zul-view-resolver-prefix empty /zul prefix prepended to a view name (i.e. a folder inside the web resource package on the classpath)
zk.zul-view-resolver-suffix .zul .zul/.zhtml usually .zul does what you need
zk.richlet-filter-mapping empty /richlets/* filter-mapping string as the basepath for richlets
zk.websockets-enabled=true true true/false enable/disable websockets (available in ZK-EE)
zk.servlet3-push-enabled=true true true/false enable/disable servlet3 CometServerPush (available in ZK-EE)
zk.update-uri /zkau /mypath configure servlet path for ZK's update engine (rarely used)

zk.homepage

Shortcut configuration to enable a Spring MVC Controller with a @GetMapping for the root path '/' returning the configured view name. (disabled by default). The default zul-view-resolver config will prepend the the servlet mapping for ZK's update engine (default /zkau) and append the .zul-extension to locate the zul file in your application.

zk.zul-view-resolver-*

Defines a simple InternalViewResolver resolving view names to zul files inside the class-web package (not required but still possible for war packaging)

The defaults above have the following effect, given the get mapping:

	@GetMapping("/demo")
	public String demo() {
		return "views/demo";
	}

Resolves to /zkau/web/views/demo.zul ZK's UpdateServlet will locate the file on the classpath e.g. in src/main/resources/web/views/demo.zul A configured prefix e.g. /myprefix will be inserted before the view name: /zkau/web[/myprefix]/views/demo.zul

zk.richlet-filter-mapping

Enables ZK's RichletFilter the value has to be a servlet filter mapping such as: /richlet/* Requires additional richlet-mappings configured in zk.xml.

You can’t perform that action at this time.