Skip to content

Commit 35e44f6

Browse files
committed
Polishing.
Update Spring Framework documentation links. See #2297
1 parent f7b3586 commit 35e44f6

File tree

6 files changed

+18
-14
lines changed

6 files changed

+18
-14
lines changed

src/main/asciidoc/index.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ Costin Leau, Jennifer Hickey, Christoph Strobl, Thomas Darimont, Mark Paluch, Ja
55
ifdef::backend-epub3[:front-cover-image: image:epub-cover.png[Front Cover,1050,1600]]
66
:spring-data-commons-include: ../../../../spring-data-commons/src/main/asciidoc
77
:spring-data-commons-docs: https://raw.githubusercontent.com/spring-projects/spring-data-commons/master/src/main/asciidoc
8+
:spring-framework-javadoc: https://docs.spring.io/spring-framework/docs/{springVersion}/javadoc-api
9+
:spring-framework-reference: https://docs.spring.io/spring-framework/docs/{springVersion}/reference/html
810

911
(C) 2011-2022 The original authors.
1012

src/main/asciidoc/preface.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,15 @@ This section provides an easy-to-follow guide for getting started with the Sprin
1010
[[get-started:first-steps:spring]]
1111
== Learning Spring
1212

13-
Spring Data uses Spring framework's https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[core] functionality, including:
13+
Spring Data uses Spring framework's
14+
{spring-framework-reference}/core.html[core] functionality, including:
1415

15-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#beans[IoC] container
16-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#validation[type conversion system]
17-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#expressions[expression language]
18-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#jmx[JMX integration]
19-
* https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[DAO exception hierarchy].
16+
17+
* {spring-framework-reference}/core.html#beans[IoC] container
18+
* {spring-framework-reference}/core.html#validation[type conversion system]
19+
* {spring-framework-reference}/core.html#expressions[expression language]
20+
* {spring-framework-reference}/integration.html#jmx[JMX integration]
21+
* {spring-framework-reference}/data-access.html#dao-exceptions[DAO exception hierarchy].
2022

2123
While you need not know the Spring APIs, understanding the concepts behind them is important.
2224
At a minimum, the idea behind Inversion of Control (IoC) should be familiar, and you should be familiar with whatever IoC container you choose to use.

src/main/asciidoc/reference/reactive-redis.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ https://github.com/lettuce-io/lettuce-core[Lettuce] supports all of the previous
2323
[[redis:reactive:connectors:connection]]
2424
=== `ReactiveRedisConnection` and `ReactiveRedisConnectionFactory`
2525

26-
`ReactiveRedisConnection` is the core of Redis communication, as it handles the communication with the Redis back-end. It also automatically translates the underlying driver exceptions to Spring's consistent DAO exception https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[hierarchy], so you can switch the connectors without any code changes, as the operation semantics remain the same.
26+
`ReactiveRedisConnection` is the core of Redis communication, as it handles the communication with the Redis back-end. It also automatically translates the underlying driver exceptions to Spring's consistent DAO exception {spring-framework-reference}/data-access.html#dao-exceptions[hierarchy], so you can switch the connectors without any code changes, as the operation semantics remain the same.
2727

28-
`ReactiveRedisConnectionFactory` creates active `ReactiveRedisConnection` instances. In addition, the factories act as `PersistenceExceptionTranslator` instances, meaning that, once declared, they let you do transparent exception translation -- for example, exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#orm-exception-translation[section] in the Spring Framework documentation.
28+
`ReactiveRedisConnectionFactory` creates active `ReactiveRedisConnection` instances. In addition, the factories act as `PersistenceExceptionTranslator` instances, meaning that, once declared, they let you do transparent exception translation -- for example, exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated {spring-framework-reference}/data-access.html#orm-exception-translation[section] in the Spring Framework documentation.
2929

3030
NOTE: Depending on the underlying configuration, the factory can return a new connection or an existing connection (in case a pool or shared native connection is used).
3131

src/main/asciidoc/reference/redis-cache.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
NOTE: Changed in 2.0
55

6-
Spring Redis provides an implementation for the Spring https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#cache[cache abstraction] through the `org.springframework.data.redis.cache` package. To use Redis as a backing implementation, add `RedisCacheManager` to your configuration, as follows:
6+
Spring Redis provides an implementation for the Spring {spring-framework-reference}/integration.html#cache[cache abstraction] through the `org.springframework.data.redis.cache` package. To use Redis as a backing implementation, add `RedisCacheManager` to your configuration, as follows:
77

88
[source,java]
99
----

src/main/asciidoc/reference/redis-transactions.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public class RedisTxContextConfiguration {
7575
}
7676
}
7777
----
78-
<1> Configures a Spring Context to enable https://docs.spring.io/spring-framework/docs/{springVersion}/reference/html/data-access.html#transaction-declarative[declarative transaction management].
78+
<1> Configures a Spring Context to enable {spring-framework-reference}/data-access.html#transaction-declarative[declarative transaction management].
7979
<2> Configures `RedisTemplate` to participate in transactions by binding connections to the current thread.
8080
<3> Transaction management requires a `PlatformTransactionManager`.
8181
Spring Data Redis does not ship with a `PlatformTransactionManager` implementation.

src/main/asciidoc/reference/redis.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ One of the first tasks when using Redis and Spring is to connect to the store th
7474
[[redis:connectors:connection]]
7575
=== RedisConnection and RedisConnectionFactory
7676

77-
`RedisConnection` provides the core building block for Redis communication, as it handles the communication with the Redis back end. It also automatically translates the underlying connecting library exceptions to Spring's consistent DAO exception https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[hierarchy] so that you can switch the connectors without any code changes, as the operation semantics remain the same.
77+
`RedisConnection` provides the core building block for Redis communication, as it handles the communication with the Redis back end. It also automatically translates the underlying connecting library exceptions to Spring's consistent DAO exception {spring-framework-reference}/data-access.html#dao-exceptions[hierarchy] so that you can switch the connectors without any code changes, as the operation semantics remain the same.
7878

7979
NOTE: For the corner cases where the native library API is required, `RedisConnection` provides a dedicated method (`getNativeConnection`) that returns the raw, underlying object used for communication.
8080

81-
Active `RedisConnection` objects are created through `RedisConnectionFactory`. In addition, the factory acts as `PersistenceExceptionTranslator` objects, meaning that, once declared, they let you do transparent exception translation. For example, you can do exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#orm-exception-translation[section] in the Spring Framework documentation.
81+
Active `RedisConnection` objects are created through `RedisConnectionFactory`. In addition, the factory acts as `PersistenceExceptionTranslator` objects, meaning that, once declared, they let you do transparent exception translation. For example, you can do exception translation through the use of the `@Repository` annotation and AOP. For more information, see the dedicated {spring-framework-reference}/data-access.html#orm-exception-translation[section] in the Spring Framework documentation.
8282

8383
NOTE: Depending on the underlying configuration, the factory can return a new connection or an existing connection (when a pool or shared native connection is used).
8484

@@ -494,7 +494,7 @@ Multiple implementations are available (including two that have been already men
494494
* `JdkSerializationRedisSerializer`, which is used by default for `RedisCache` and `RedisTemplate`.
495495
* the `StringRedisSerializer`.
496496

497-
However one can use `OxmSerializer` for Object/XML mapping through Spring https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#oxm[OXM] support or `Jackson2JsonRedisSerializer` or `GenericJackson2JsonRedisSerializer` for storing data in https://en.wikipedia.org/wiki/JSON[JSON] format.
497+
However one can use `OxmSerializer` for Object/XML mapping through Spring {spring-framework-reference}/data-access.html#oxm[OXM] support or `Jackson2JsonRedisSerializer` or `GenericJackson2JsonRedisSerializer` for storing data in https://en.wikipedia.org/wiki/JSON[JSON] format.
498498

499499
Do note that the storage format is not limited only to values. It can be used for keys, values, or hashes without any restrictions.
500500

@@ -524,7 +524,7 @@ Hash mappers are converters of map objects to a `Map<K, V>` and back. `HashMappe
524524

525525
Multiple implementations are available:
526526

527-
* `BeanUtilsHashMapper` using Spring's https://docs.spring.io/spring/docs/{springVersion}/javadoc-api/org/springframework/beans/BeanUtils.html[BeanUtils].
527+
* `BeanUtilsHashMapper` using Spring's {spring-framework-javadoc}/org/springframework/beans/BeanUtils.html[BeanUtils].
528528
* `ObjectHashMapper` using <<redis.repositories.mapping>>.
529529
* <<redis.hashmappers.jackson2,`Jackson2HashMapper`>> using https://github.com/FasterXML/jackson[FasterXML Jackson].
530530

0 commit comments

Comments
 (0)