From ef11aa45837ad7f5f147b9bb0cc0d9fcbc8aa660 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Tue, 19 Mar 2019 18:59:03 +0100 Subject: [PATCH] Update documentation for WebJar support Prior to this commit, documentation for WebJar support referenced the webjars-locator artifact; however, Spring now uses the webjars-locator-core artifact. This commit updates the documentation to reflect this. Closes gh-22613 --- .../reactive/resource/WebJarsResourceResolver.java | 6 +++--- .../web/servlet/resource/WebJarsResourceResolver.java | 6 +++--- src/docs/asciidoc/web/webflux.adoc | 11 ++++++----- src/docs/asciidoc/web/webmvc.adoc | 9 +++++---- 4 files changed, 17 insertions(+), 15 deletions(-) diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/resource/WebJarsResourceResolver.java b/spring-webflux/src/main/java/org/springframework/web/reactive/resource/WebJarsResourceResolver.java index 8fc571245c2..55023d81d00 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/resource/WebJarsResourceResolver.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/resource/WebJarsResourceResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -36,8 +36,8 @@ import org.springframework.web.server.ServerWebExchange; * *

This also resolves resources for version agnostic HTTP requests {@code "GET /jquery/jquery.min.js"}. * - *

This resolver requires the "org.webjars:webjars-locator" library on classpath, - * and is automatically registered if that library is present. + *

This resolver requires the {@code org.webjars:webjars-locator-core} library + * on the classpath and is automatically registered if that library is present. * * @author Rossen Stoyanchev * @author Brian Clozel diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/WebJarsResourceResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/WebJarsResourceResolver.java index 1b886df63c5..c3661686b08 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/WebJarsResourceResolver.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/WebJarsResourceResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -35,8 +35,8 @@ import org.springframework.lang.Nullable; * *

This also resolves resources for version agnostic HTTP requests {@code "GET /jquery/jquery.min.js"}. * - *

This resolver requires the "org.webjars:webjars-locator" library on classpath, - * and is automatically registered if that library is present. + *

This resolver requires the {@code org.webjars:webjars-locator-core} library + * on the classpath and is automatically registered if that library is present. * * @author Brian Clozel * @since 4.2 diff --git a/src/docs/asciidoc/web/webflux.adoc b/src/docs/asciidoc/web/webflux.adoc index 72d977482a9..b8484f86d8d 100644 --- a/src/docs/asciidoc/web/webflux.adoc +++ b/src/docs/asciidoc/web/webflux.adoc @@ -3355,11 +3355,12 @@ Note that, when using both `EncodedResourceResolver` (for example, Gzip, Brotli `VersionedResourceResolver`, they must be registered in that order, to ensure content-based versions are always computed reliably based on the unencoded file. -http://www.webjars.org/documentation[WebJars] is also supported through `WebJarsResourceResolver` -and is automatically registered when `org.webjars:webjars-locator` is present on the -classpath. The resolver can re-write URLs to include the version of the jar and can also -match to incoming URLs without versions (for example, `/jquery/jquery.min.js` to -`/jquery/1.2.0/jquery.min.js`). +http://www.webjars.org/documentation[WebJars] are also supported through the +`WebJarsResourceResolver` which is automatically registered when the +`org.webjars:webjars-locator-core` library is present on the classpath. The resolver can +re-write URLs to include the version of the jar and can also match against incoming URLs +without versions -- for example, from `/jquery/jquery.min.js` to +`/jquery/1.2.0/jquery.min.js`. diff --git a/src/docs/asciidoc/web/webmvc.adoc b/src/docs/asciidoc/web/webmvc.adoc index 6d097493f45..5a1c29c91a1 100644 --- a/src/docs/asciidoc/web/webmvc.adoc +++ b/src/docs/asciidoc/web/webmvc.adoc @@ -4757,10 +4757,11 @@ Note that, when using both `EncodedResourceResolver` (for example, for serving g brotli-encoded resources) and `VersionedResourceResolver`, you must register them in this order. That ensures content-based versions are always computed reliably, based on the unencoded file. -http://www.webjars.org/documentation[WebJars] is also supported through `WebJarsResourceResolver` -and is automatically registered when `org.webjars:webjars-locator` is present on the -classpath. The resolver can re-write URLs to include the version of the jar and can also -match to incoming URLs without versions -- for example, `/jquery/jquery.min.js` to +http://www.webjars.org/documentation[WebJars] are also supported through the +`WebJarsResourceResolver` which is automatically registered when the +`org.webjars:webjars-locator-core` library is present on the classpath. The resolver can +re-write URLs to include the version of the jar and can also match against incoming URLs +without versions -- for example, from `/jquery/jquery.min.js` to `/jquery/1.2.0/jquery.min.js`.