Skip to content

Commit 4ef16b1

Browse files
committed
Update terminology to HTTP Service Clients
Closes gh-17947
1 parent a63e87d commit 4ef16b1

File tree

6 files changed

+21
-21
lines changed

6 files changed

+21
-21
lines changed

docs/modules/ROOT/nav.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
*** xref:features/exploits/http.adoc[HTTP Requests]
2222
** xref:features/integrations/index.adoc[Integrations]
2323
*** REST Client
24-
**** xref:features/integrations/rest/http-interface.adoc[HTTP Interface Integration]
24+
**** xref:features/integrations/rest/http-service-client.adoc[HTTP Service Clients]
2525
*** xref:features/integrations/cryptography.adoc[Cryptography]
2626
*** xref:features/integrations/data.adoc[Spring Data]
2727
*** xref:features/integrations/concurrency.adoc[Java's Concurrency APIs]

docs/modules/ROOT/pages/features/integrations/rest/http-interface.adoc renamed to docs/modules/ROOT/pages/features/integrations/rest/http-service-client.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
= HTTP Interface Integration
1+
= HTTP Service Clients Integration
22

3-
Spring Security's OAuth Support can integrate with `RestClient` and `WebClient` {spring-framework-reference-url}/integration/rest-clients.html[HTTP Interface based REST Clients].
3+
Spring Security's OAuth Support can integrate with `RestClient` and `WebClient` {spring-framework-reference-url}integration/rest-clients.html#rest-http-service-client[HTTP Service Clients].
44

55

66
[[configuration]]
77
== Configuration
8-
After xref:features/integrations/rest/http-interface.adoc#configuration-restclient[RestClient] or xref:features/integrations/rest/http-interface.adoc#configuration-webclient[WebClient] specific configuration, usage of xref:features/integrations/rest/http-interface.adoc[] only requires adding a xref:features/integrations/rest/http-interface.adoc#client-registration-id[`@ClientRegistrationId`] to methods that require OAuth or their declaring HTTP interface.
8+
After xref:features/integrations/rest/http-service-client.adoc#configuration-restclient[RestClient] or xref:features/integrations/rest/http-service-client.adoc#configuration-webclient[WebClient] specific configuration, usage of xref:features/integrations/rest/http-service-client.adoc[] only requires adding a xref:features/integrations/rest/http-service-client.adoc#client-registration-id[`@ClientRegistrationId`] to methods that require OAuth or their declaring HTTP interface.
99

10-
Since the presence of xref:features/integrations/rest/http-interface.adoc#client-registration-id[`@ClientRegistrationId`] determines if and how the OAuth token will be resolved, it is safe to add Spring Security's OAuth support any configuration.
10+
Since the presence of xref:features/integrations/rest/http-service-client.adoc#client-registration-id[`@ClientRegistrationId`] determines if and how the OAuth token will be resolved, it is safe to add Spring Security's OAuth support any configuration.
1111

1212
[[configuration-restclient]]
1313
=== RestClient Configuration
1414

15-
Spring Security's OAuth Support can integrate with {spring-framework-reference-url}/integration/rest-clients.html[HTTP Interface based REST Clients] backed by RestClient.
15+
Spring Security's OAuth Support can integrate with {spring-framework-reference-url}integration/rest-clients.html#rest-http-service-client[HTTP Service Clients] backed by `RestClient`.
1616
The first step is to xref:servlet/oauth2/client/core.adoc#oauth2Client-authorized-manager-provider[create an `OAuthAuthorizedClientManager` Bean].
1717

18-
Next you must configure `HttpServiceProxyFactory` and `RestClient` to be aware of xref:./http-interface.adoc#client-registration-id[@ClientRegistrationId]
18+
Next you must configure `HttpServiceProxyFactory` and `RestClient` to be aware of xref:./http-service-client.adoc#client-registration-id[@ClientRegistrationId]
1919
To simplify this configuration, use javadoc:org.springframework.security.oauth2.client.web.client.support.OAuth2RestClientHttpServiceGroupConfigurer[].
2020

2121
include-code::./RestClientHttpInterfaceIntegrationConfiguration[tag=config,indent=0]
2222

2323
The configuration:
2424

25-
- Adds xref:features/integrations/rest/http-interface.adoc#client-registration-id-processor[`ClientRegistrationIdProcessor`] to {spring-framework-reference-url}/integration/rest-clients.html#rest-http-interface[`HttpServiceProxyFactory`]
25+
- Adds xref:features/integrations/rest/http-service-client.adoc#client-registration-id-processor[`ClientRegistrationIdProcessor`] to {spring-framework-reference-url}integration/rest-clients.html#rest-http-service-client[`HttpServiceProxyFactory`]
2626
- Adds xref:servlet/oauth2/client/authorized-clients.adoc#oauth2-client-rest-client[`OAuth2ClientHttpRequestInterceptor`] to the `RestClient`
2727

2828
[[configuration-webclient]]
2929
=== WebClient Configuration
3030

31-
Spring Security's OAuth Support can integrate with {spring-framework-reference-url}/integration/rest-clients.html[HTTP Interface based REST Clients] backed by `WebClient`.
31+
Spring Security's OAuth Support can integrate with {spring-framework-reference-url}integration/rest-clients.html#rest-http-service-client[HTTP Service Clients] backed by `WebClient`.
3232
The first step is to xref:reactive/oauth2/client/core.adoc#oauth2Client-authorized-manager-provider[create an `ReactiveOAuthAuthorizedClientManager` Bean].
3333

34-
Next you must configure `HttpServiceProxyFactory` and `WebRestClient` to be aware of xref:./http-interface.adoc#client-registration-id[@ClientRegistrationId]
34+
Next you must configure `HttpServiceProxyFactory` and `WebRestClient` to be aware of xref:./http-service-client.adoc#client-registration-id[@ClientRegistrationId]
3535
To simplify this configuration, use javadoc:org.springframework.security.oauth2.client.web.reactive.function.client.support.OAuth2WebClientHttpServiceGroupConfigurer[].
3636

3737
include-code::./ServerWebClientHttpInterfaceIntegrationConfiguration[tag=config,indent=0]
3838

3939
The configuration:
4040

41-
- Adds xref:features/integrations/rest/http-interface.adoc#client-registration-id-processor[`ClientRegistrationIdProcessor`] to {spring-framework-reference-url}/integration/rest-clients.html#rest-http-interface[`HttpServiceProxyFactory`]
41+
- Adds xref:features/integrations/rest/http-service-client.adoc#client-registration-id-processor[`ClientRegistrationIdProcessor`] to {spring-framework-reference-url}/integration/rest-clients.html#rest-http-service-client[`HttpServiceProxyFactory`]
4242
- Adds xref:reactive/oauth2/client/authorized-clients.adoc#oauth2-client-web-client[`ServerOAuth2AuthorizedClientExchangeFilterFunction`] to the `WebClient`
4343

4444

4545
[[client-registration-id]]
4646
== @ClientRegistrationId
4747

48-
You can add the javadoc:org.springframework.security.oauth2.client.annotation.ClientRegistrationId[] on the HTTP Interface to specify which javadoc:org.springframework.security.oauth2.client.registration.ClientRegistration[] to use.
48+
You can add the javadoc:org.springframework.security.oauth2.client.annotation.ClientRegistrationId[] on the HTTP Service to specify which javadoc:org.springframework.security.oauth2.client.registration.ClientRegistration[] to use.
4949

5050
include-code::./UserService[tag=getAuthenticatedUser]
5151

52-
The xref:features/integrations/rest/http-interface.adoc#client-registration-id[`@ClientRegistrationId`] will be processed by xref:features/integrations/rest/http-interface.adoc#client-registration-id-processor[`ClientRegistrationIdProcessor`]
52+
The xref:features/integrations/rest/http-service-client.adoc#client-registration-id[`@ClientRegistrationId`] will be processed by xref:features/integrations/rest/http-service-client.adoc#client-registration-id-processor[`ClientRegistrationIdProcessor`]
5353

5454
[[type]]
5555
=== Type Level Declarations
@@ -61,9 +61,9 @@ include-code::./UserService[tag=type]
6161
[[client-registration-id-processor]]
6262
== `ClientRegistrationIdProcessor`
6363

64-
The xref:features/integrations/rest/http-interface.adoc#configuration[configured] javadoc:org.springframework.security.oauth2.client.web.client.ClientRegistrationIdProcessor[] will:
64+
The xref:features/integrations/rest/http-service-client.adoc#configuration[configured] javadoc:org.springframework.security.oauth2.client.web.client.ClientRegistrationIdProcessor[] will:
6565

66-
- Automatically invoke javadoc:org.springframework.security.oauth2.client.web.ClientAttributes#clientRegistrationId(java.lang.String)[] for each xref:features/integrations/rest/http-interface.adoc#client-registration-id[`@ClientRegistrationId`].
66+
- Automatically invoke javadoc:org.springframework.security.oauth2.client.web.ClientAttributes#clientRegistrationId(java.lang.String)[] for each xref:features/integrations/rest/http-service-client.adoc#client-registration-id[`@ClientRegistrationId`].
6767
- This adds the javadoc:org.springframework.security.oauth2.client.registration.ClientRegistration#getId()[] to the attributes
6868

6969
The `id` is then processed by:

docs/modules/ROOT/pages/servlet/oauth2/client/authorized-clients.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -495,9 +495,9 @@ class RestClientConfig {
495495
=====
496496

497497
[[oauth2-client-rest-client-interface]]
498-
=== HTTP Interface Integration
498+
=== HTTP Service Clients
499499

500-
Spring Security's OAuth support integrates with xref:features/integrations/rest/http-interface.adoc[].
500+
Spring Security's OAuth support integrates with xref:features/integrations/rest/http-service-client.adoc[].
501501

502502
[[oauth2-client-web-client]]
503503
== [[oauth2Client-webclient-servlet]]WebClient Integration for Servlet Environments

docs/modules/ROOT/pages/whats-new.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ http.csrf((csrf) -> csrf.spa());
5656
== OAuth 2.0
5757

5858
* Removed support for password grant
59-
* Added OAuth2 Support for xref:features/integrations/rest/http-interface.adoc[HTTP Interface Integration]
59+
* Added OAuth2 Support for xref:features/integrations/rest/http-service-client.adoc[HTTP Service Clients]
6060
* Added support for custom `JwkSource` in `NimbusJwtDecoder`, allowing usage of Nimbus's `JwkSourceBuilder` API
6161
* Added builder for `NimbusJwtEncoder`, supports specifying an EC or RSA key pair or a secret key
62-
* Added support for `@ClientRegistrationId` at the xref:features/integrations/rest/http-interface.adoc#type[type level], eliminating the need for method level repetition
62+
* Added support for `@ClientRegistrationId` at the xref:features/integrations/rest/http-service-client.adoc#type[type level], eliminating the need for method level repetition
6363

6464
== SAML 2.0
6565

docs/src/test/java/org/springframework/security/docs/features/integrations/rest/clientregistrationid/UserService.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
import org.springframework.web.service.annotation.HttpExchange;
2222

2323
/**
24-
* Demonstrates a service for {@link ClientRegistrationId} and HTTP Interface clients.
24+
* Demonstrates a service for {@link ClientRegistrationId} and HTTP Service clients.
2525
* @author Rob Winch
2626
*/
2727
@HttpExchange

docs/src/test/kotlin/org/springframework/security/kt/docs/features/integrations/rest/clientregistrationid/UserService.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import org.springframework.web.service.annotation.GetExchange
2121
import org.springframework.web.service.annotation.HttpExchange
2222

2323
/**
24-
* Demonstrates a service for {@link ClientRegistrationId} and HTTP Interface clients.
24+
* Demonstrates a service for {@link ClientRegistrationId} and HTTP Service Clients.
2525
* @author Rob Winch
2626
*/
2727
@HttpExchange

0 commit comments

Comments
 (0)