diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc index 06540331..9adcf4a1 100644 --- a/src/main/asciidoc/index.adoc +++ b/src/main/asciidoc/index.adoc @@ -4,6 +4,7 @@ Mark Paluch; :revdate: {localdate} :toc: macro :toc-placement!: +:spring-framework-docs: http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/ (C) 2016-2017 The original authors. diff --git a/src/main/asciidoc/preface.adoc b/src/main/asciidoc/preface.adoc index cf240fc3..4bfcdb0d 100644 --- a/src/main/asciidoc/preface.adoc +++ b/src/main/asciidoc/preface.adoc @@ -21,7 +21,7 @@ as well as Spring concepts. [[get-started:first-steps:spring]] == Knowing Spring -Spring Vault uses Spring framework's http://docs.spring.io/spring/docs/4.2.x/spring-framework-reference/html/spring-core.html[core] functionality, such as the http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/html/beans.html[IoC] container. While it is not important to know the Spring APIs, understanding the concepts behind them is. At a minimum, the idea behind IoC should be familiar for whatever IoC container you choose to use. +Spring Vault uses Spring framework's {spring-framework-docs}html/spring-core.html[core] functionality, such as {spring-framework-docs}/html/beans.html[IoC] container. While it is not important to know the Spring APIs, understanding the concepts behind them is. At a minimum, the idea behind IoC should be familiar for whatever IoC container you choose to use. The core functionality of the Vault support can be used directly, with no need to invoke the IoC services of the Spring Container. This is much like `RestTemplate` which can be used 'standalone' without any other services of the Spring container. To leverage all the features of Spring Vault document, such as the session support, you will need to configure some parts of the library using Spring. diff --git a/src/main/asciidoc/reference/authentication.adoc b/src/main/asciidoc/reference/authentication.adoc index 483210d2..efef3f55 100644 --- a/src/main/asciidoc/reference/authentication.adoc +++ b/src/main/asciidoc/reference/authentication.adoc @@ -15,7 +15,7 @@ Disclosure of login credentials to any party allows login to Vault and access se are permitted by the underlying role. Picking the appropriate client authentication and injecting credentials into the application is subject to risk evaluation. -Spring's http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/beans.html#beans-property-source-abstraction[PropertySource abstraction] is a natural fit +Spring's {spring-framework-docs}/html/beans.html#beans-property-source-abstraction[PropertySource abstraction] is a natural fit to keep configuration outside the application code. You can use system properties, environment variables or property files to store login credentials. Each approach comes with its own properties. Keep in mind that the command line and environment properties can be introspected with appropriate diff --git a/src/main/asciidoc/reference/client-support.adoc b/src/main/asciidoc/reference/client-support.adoc index 2c85435e..890c3b44 100644 --- a/src/main/asciidoc/reference/client-support.adoc +++ b/src/main/asciidoc/reference/client-support.adoc @@ -2,7 +2,7 @@ = Client support Spring Vault supports a various HTTP clients to access Vault's HTTP API. Spring Vault uses -http://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/html/remoting.html#rest-resttemplate[`RestTemplate`] as primary interface accessing Vault. +{spring-framework-docs}html/remoting.html#rest-resttemplate[`RestTemplate`] as primary interface accessing Vault. Dedicated client support originates from <> that is scoped only to Spring Vault's client components. diff --git a/src/main/asciidoc/reference/getting-started.adoc b/src/main/asciidoc/reference/getting-started.adoc index 2c93217d..258df27e 100644 --- a/src/main/asciidoc/reference/getting-started.adoc +++ b/src/main/asciidoc/reference/getting-started.adoc @@ -182,7 +182,7 @@ Now let's look at a examples of how to work with Vault in the context of the Spr === Registering and configuring Spring Vault beans Using Spring Vault does not require a Spring Context. However, instances of `VaultTemplate` and `SessionManager` registered inside a managed context will participate -in http://docs.spring.io/spring/docs/current/spring-framework-reference/html/beans.html#beans-factory-nature[lifecycle events] +in {spring-framework-docs}html/beans.html#beans-factory-nature[lifecycle events] provided by the Spring IoC container. This is useful to dispose active Vault sessions upon application shutdown. You also benefit from reusing the same `VaultTemplate` instance across your application. @@ -388,7 +388,7 @@ No configuration options. Vault can be used in many different ways. One specific use-case is using Vault to store encrypted properties. Spring Vault supports Vault as property -source to obtain configuration properties using Spring's http://docs.spring.io/spring-framework/docs/current/spring-framework-reference/html/beans.html#beans-property-source-abstraction[PropertySource abstraction]. +source to obtain configuration properties using Spring's {spring-framework-docs}beans.html#beans-property-source-abstraction[PropertySource abstraction]. NOTE: You can reference properties stored inside Vault in other property sources or use value injection with `@Value(…)`. Special attention is required when bootstrapping beans that require data stored inside of Vault. A `VaultPropertySource` must be initialized at that time to retrieve properties from Vault. @@ -491,8 +491,8 @@ For example, if the `@Configuration` classes above were registered via component-scanning, the ordering is difficult to predict. In such cases - and if overriding is important - it is recommended that the user fall back to using the programmatic PropertySource API. -See http://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/env/ConfigurableEnvironment.html[`ConfigurableEnvironment`] and -http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/MutablePropertySources.html[`MutablePropertySources`] for details. +See http://docs.spring.io/spring-framework/docs/{springVersion}/javadoc-api/org/springframework/core/env/ConfigurableEnvironment.html[`ConfigurableEnvironment`] and +http://docs.spring.io/spring/docs/{springVersion}/javadoc-api/org/springframework/core/env/MutablePropertySources.html[`MutablePropertySources`] for details. [[vault.core.executioncallback]]