Skip to content

Commit a5af850

Browse files
jzheauxjzheaux
committed
Update OpaqueTokenIntrospector Documentation
Issue gh-15988
1 parent aced3bc commit a5af850

File tree

2 files changed

+64
-33
lines changed

2 files changed

+64
-33
lines changed

‎docs/modules/ROOT/pages/reactive/oauth2/resource-server/opaque-token.adoc

+32-16
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,8 @@ Java::
273273
----
274274
@Bean
275275
public ReactiveOpaqueTokenIntrospector introspector() {
276-
return new NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret);
276+
return SpringReactiveOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
277+
.clientId(clientId).clientSecret(clientSecret).build();
277278
}
278279
----
279280
@@ -283,7 +284,8 @@ Kotlin::
283284
----
284285
@Bean
285286
fun introspector(): ReactiveOpaqueTokenIntrospector {
286-
return NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
287+
return SpringReactiveOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
288+
.clientId(clientId).clientSecret(clientSecret).build()
287289
}
288290
----
289291
======
@@ -411,7 +413,8 @@ Java::
411413
----
412414
@Bean
413415
public ReactiveOpaqueTokenIntrospector introspector() {
414-
return new NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret);
416+
return SpringReactiveOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
417+
.clientId(clientId).clientSecret(clientSecret).build()
415418
}
416419
----
417420
@@ -421,7 +424,8 @@ Kotlin::
421424
----
422425
@Bean
423426
fun introspector(): ReactiveOpaqueTokenIntrospector {
424-
return NimbusReactiveOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
427+
return SpringReactiveOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
428+
.clientId(clientId).clientSecret(clientSecret).build()
425429
}
426430
----
427431
======
@@ -534,8 +538,9 @@ Java::
534538
[source,java,role="primary"]
535539
----
536540
public class CustomAuthoritiesOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
537-
private ReactiveOpaqueTokenIntrospector delegate =
538-
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
541+
private ReactiveOpaqueTokenIntrospector delegate = SpringReactiveOpaqueTokenIntrospector
542+
.withIntrospectionUri("https://idp.example.org/introspect")
543+
.clientId("client").clientSecret("secret").build();
539544
540545
public Mono<OAuth2AuthenticatedPrincipal> introspect(String token) {
541546
return this.delegate.introspect(token)
@@ -557,7 +562,9 @@ Kotlin::
557562
[source,kotlin,role="secondary"]
558563
----
559564
class CustomAuthoritiesOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
560-
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
565+
private val delegate: ReactiveOpaqueTokenIntrospector = SpringReactiveOpaqueTokenIntrospector
566+
.withIntrospectionUri("https://idp.example.org/introspect")
567+
.clientId("client").clientSecret("secret").build()
561568
override fun introspect(token: String): Mono<OAuth2AuthenticatedPrincipal> {
562569
return delegate.introspect(token)
563570
.map { principal: OAuth2AuthenticatedPrincipal ->
@@ -637,8 +644,9 @@ Java::
637644
[source,java,role="primary"]
638645
----
639646
public class JwtOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
640-
private ReactiveOpaqueTokenIntrospector delegate =
641-
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
647+
private ReactiveOpaqueTokenIntrospector delegate = SpringReactiveOpaqueTokenIntrospector
648+
.withIntrospectionUri("https://idp.example.org/introspect")
649+
.clientId("client").clientSecret("secret").build();
642650
private ReactiveJwtDecoder jwtDecoder = new NimbusReactiveJwtDecoder(new ParseOnlyJWTProcessor());
643651
644652
public Mono<OAuth2AuthenticatedPrincipal> introspect(String token) {
@@ -664,7 +672,9 @@ Kotlin::
664672
[source,kotlin,role="secondary"]
665673
----
666674
class JwtOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
667-
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
675+
private val delegate: ReactiveOpaqueTokenIntrospector = SpringReactiveOpaqueTokenIntrospector
676+
.withIntrospectionUri("https://idp.example.org/introspect")
677+
.clientId("client").clientSecret("secret").build()
668678
private val jwtDecoder: ReactiveJwtDecoder = NimbusReactiveJwtDecoder(ParseOnlyJWTProcessor())
669679
override fun introspect(token: String): Mono<OAuth2AuthenticatedPrincipal> {
670680
return delegate.introspect(token)
@@ -731,8 +741,9 @@ Java::
731741
[source,java,role="primary"]
732742
----
733743
public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
734-
private final ReactiveOpaqueTokenIntrospector delegate =
735-
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
744+
private final ReactiveOpaqueTokenIntrospector delegate = SpringReactiveOpaqueTokenIntrospector
745+
.withIntrospectionUri("https://idp.example.org/introspect")
746+
.clientId("client").clientSecret("secret").build();
736747
private final ReactiveOAuth2UserService<OAuth2UserRequest, OAuth2User> oauth2UserService =
737748
new DefaultReactiveOAuth2UserService();
738749
@@ -761,7 +772,9 @@ Kotlin::
761772
[source,kotlin,role="secondary"]
762773
----
763774
class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
764-
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
775+
private val delegate: ReactiveOpaqueTokenIntrospector = SpringReactiveOpaqueTokenIntrospector
776+
.withIntrospectionUri("https://idp.example.org/introspect")
777+
.clientId("client").clientSecret("secret").build()
765778
private val oauth2UserService: ReactiveOAuth2UserService<OAuth2UserRequest, OAuth2User> = DefaultReactiveOAuth2UserService()
766779
private val repository: ReactiveClientRegistrationRepository? = null
767780
@@ -792,8 +805,9 @@ Java::
792805
[source,java,role="primary"]
793806
----
794807
public class UserInfoOpaqueTokenIntrospector implements ReactiveOpaqueTokenIntrospector {
795-
private final ReactiveOpaqueTokenIntrospector delegate =
796-
new NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
808+
private final ReactiveOpaqueTokenIntrospector delegate = SpringReactiveOpaqueTokenIntrospector
809+
.withIntrospectionUri("https://idp.example.org/introspect")
810+
.clientId("client").clientSecret("secret").build();
797811
private final WebClient rest = WebClient.create();
798812
799813
@Override
@@ -809,7 +823,9 @@ Kotlin::
809823
[source,kotlin,role="secondary"]
810824
----
811825
class UserInfoOpaqueTokenIntrospector : ReactiveOpaqueTokenIntrospector {
812-
private val delegate: ReactiveOpaqueTokenIntrospector = NimbusReactiveOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
826+
private val delegate: ReactiveOpaqueTokenIntrospector = SpringReactiveOpaqueTokenIntrospector
827+
.withIntrospectionUri("https://idp.example.org/introspect")
828+
.clientId("client").clientSecret("secret").build()
813829
private val rest: WebClient = WebClient.create()
814830
815831
override fun introspect(token: String): Mono<OAuth2AuthenticatedPrincipal> {

‎docs/modules/ROOT/pages/servlet/oauth2/resource-server/opaque-token.adoc

+32-17
Original file line numberDiff line numberDiff line change
@@ -307,7 +307,8 @@ Java::
307307
----
308308
@Bean
309309
public OpaqueTokenIntrospector introspector() {
310-
return new NimbusOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret);
310+
return SpringOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
311+
.clientId(clientId).clientSecret(clientSecret).build();
311312
}
312313
----
313314
@@ -317,7 +318,8 @@ Kotlin::
317318
----
318319
@Bean
319320
fun introspector(): OpaqueTokenIntrospector {
320-
return NimbusOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret)
321+
return SpringOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
322+
.clientId(clientId).clientSecret(clientSecret).build()
321323
}
322324
----
323325
======
@@ -532,7 +534,8 @@ Or, exposing a <<oauth2resourceserver-opaque-architecture-introspector,`OpaqueTo
532534
----
533535
@Bean
534536
public OpaqueTokenIntrospector introspector() {
535-
return new NimbusOpaqueTokenIntrospector(introspectionUri, clientId, clientSecret);
537+
return return SpringOpaqueTokenIntrospector.withIntrospectionUri(introspectionUri)
538+
.clientId(clientId).clientSecret(clientSecret).build();
536539
}
537540
----
538541

@@ -662,8 +665,9 @@ Java::
662665
[source,java,role="primary"]
663666
----
664667
public class CustomAuthoritiesOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
665-
private OpaqueTokenIntrospector delegate =
666-
new NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
668+
private OpaqueTokenIntrospector delegate = SpringOpaqueTokenIntrospector
669+
.withIntrospectionUri("https://idp.example.org/introspect")
670+
.clientId("client").clientSecret("secret").build();
667671
668672
public OAuth2AuthenticatedPrincipal introspect(String token) {
669673
OAuth2AuthenticatedPrincipal principal = this.delegate.introspect(token);
@@ -685,7 +689,9 @@ Kotlin::
685689
[source,kotlin,role="secondary"]
686690
----
687691
class CustomAuthoritiesOpaqueTokenIntrospector : OpaqueTokenIntrospector {
688-
private val delegate: OpaqueTokenIntrospector = NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
692+
private val delegate: OpaqueTokenIntrospector = SpringOpaqueTokenIntrospector
693+
.withIntrospectionUri("https://idp.example.org/introspect")
694+
.clientId("client").clientSecret("secret").build()
689695
override fun introspect(token: String): OAuth2AuthenticatedPrincipal {
690696
val principal: OAuth2AuthenticatedPrincipal = delegate.introspect(token)
691697
return DefaultOAuth2AuthenticatedPrincipal(
@@ -750,7 +756,7 @@ public OpaqueTokenIntrospector introspector(RestTemplateBuilder builder, OAuth2R
750756
.setReadTimeout(Duration.ofSeconds(60))
751757
.build();
752758
753-
return new NimbusOpaqueTokenIntrospector(introspectionUri, rest);
759+
return SpringOpaqueTokenIntrospector(introspectionUri, rest);
754760
}
755761
----
756762
@@ -765,7 +771,7 @@ fun introspector(builder: RestTemplateBuilder, properties: OAuth2ResourceServerP
765771
.setConnectTimeout(Duration.ofSeconds(60))
766772
.setReadTimeout(Duration.ofSeconds(60))
767773
.build()
768-
return NimbusOpaqueTokenIntrospector(introspectionUri, rest)
774+
return SpringOpaqueTokenIntrospector(introspectionUri, rest)
769775
}
770776
----
771777
======
@@ -807,8 +813,9 @@ Java::
807813
[source,java,role="primary"]
808814
----
809815
public class JwtOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
810-
private OpaqueTokenIntrospector delegate =
811-
new NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
816+
private OpaqueTokenIntrospector delegate = SpringOpaqueTokenIntrospector
817+
.withIntrospectionUri("https://idp.example.org/introspect")
818+
.clientId("client").clientSecret("secret").build();
812819
private JwtDecoder jwtDecoder = new NimbusJwtDecoder(new ParseOnlyJWTProcessor());
813820
814821
public OAuth2AuthenticatedPrincipal introspect(String token) {
@@ -835,7 +842,9 @@ Kotlin::
835842
[source,kotlin,role="secondary"]
836843
----
837844
class JwtOpaqueTokenIntrospector : OpaqueTokenIntrospector {
838-
private val delegate: OpaqueTokenIntrospector = NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
845+
private val delegate: OpaqueTokenIntrospector = SpringOpaqueTokenIntrospector
846+
.withIntrospectionUri("https://idp.example.org/introspect")
847+
.clientId("client").clientSecret("secret").build()
839848
private val jwtDecoder: JwtDecoder = NimbusJwtDecoder(ParseOnlyJWTProcessor())
840849
override fun introspect(token: String): OAuth2AuthenticatedPrincipal {
841850
val principal = delegate.introspect(token)
@@ -902,8 +911,9 @@ Java::
902911
[source,java,role="primary"]
903912
----
904913
public class UserInfoOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
905-
private final OpaqueTokenIntrospector delegate =
906-
new NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
914+
private final OpaqueTokenIntrospector delegate = SpringOpaqueTokenIntrospector
915+
.withIntrospectionUri("https://idp.example.org/introspect")
916+
.clientId("client").clientSecret("secret").build();
907917
private final OAuth2UserService oauth2UserService = new DefaultOAuth2UserService();
908918
909919
private final ClientRegistrationRepository repository;
@@ -928,7 +938,9 @@ Kotlin::
928938
[source,kotlin,role="secondary"]
929939
----
930940
class UserInfoOpaqueTokenIntrospector : OpaqueTokenIntrospector {
931-
private val delegate: OpaqueTokenIntrospector = NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
941+
private val delegate: OpaqueTokenIntrospector = SpringOpaqueTokenIntrospector
942+
.withIntrospectionUri("https://idp.example.org/introspect")
943+
.clientId("client").clientSecret("secret").build()
932944
private val oauth2UserService = DefaultOAuth2UserService()
933945
private val repository: ClientRegistrationRepository? = null
934946
@@ -957,8 +969,9 @@ Java::
957969
[source,java,role="primary"]
958970
----
959971
public class UserInfoOpaqueTokenIntrospector implements OpaqueTokenIntrospector {
960-
private final OpaqueTokenIntrospector delegate =
961-
new NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret");
972+
private final OpaqueTokenIntrospector delegate = SpringOpaqueTokenIntrospector
973+
.withIntrospectionUri("https://idp.example.org/introspect")
974+
.clientId("client").clientSecret("secret").build();
962975
private final WebClient rest = WebClient.create();
963976
964977
@Override
@@ -974,7 +987,9 @@ Kotlin::
974987
[source,kotlin,role="secondary"]
975988
----
976989
class UserInfoOpaqueTokenIntrospector : OpaqueTokenIntrospector {
977-
private val delegate: OpaqueTokenIntrospector = NimbusOpaqueTokenIntrospector("https://idp.example.org/introspect", "client", "secret")
990+
private val delegate: OpaqueTokenIntrospector = SpringOpaqueTokenIntrospector
991+
.withIntrospectionUri("https://idp.example.org/introspect")
992+
.clientId("client").clientSecret("secret").build()
978993
private val rest: WebClient = WebClient.create()
979994
980995
override fun introspect(token: String): OAuth2AuthenticatedPrincipal {

0 commit comments

Comments
 (0)