Skip to content

Commit 4d9d40e

Browse files
committed
Update validateType JavaDoc
Closes gh-18227 Signed-off-by: Josh Cummings <[email protected]>
1 parent 29b9dc6 commit 4d9d40e

File tree

1 file changed

+18
-30
lines changed

1 file changed

+18
-30
lines changed

oauth2/oauth2-jose/src/main/java/org/springframework/security/oauth2/jwt/NimbusJwtDecoder.java

Lines changed: 18 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -319,21 +319,17 @@ private JwkSetUriJwtDecoderBuilder(Function<RestOperations, String> jwkSetUri,
319319
}
320320

321321
/**
322-
* Whether to use Nimbus's typ header verification. This is {@code true} by
323-
* default, however it may change to {@code false} in a future major release.
322+
* Whether to use Nimbus's {@code typ} header verification. This is {@code false}
323+
* by default.
324324
*
325325
* <p>
326-
* By turning off this feature, {@link NimbusJwtDecoder} expects applications to
327-
* check the {@code typ} header themselves in order to determine what kind of
328-
* validation is needed
326+
* By turning on this feature, {@link NimbusJwtDecoder} will delegate checking the
327+
* {@code typ} header to Nimbus by using Nimbus's default
328+
* {@link JOSEObjectTypeVerifier}.
329329
* </p>
330330
*
331331
* <p>
332-
* This is done for you when you use {@link JwtValidators} to construct a
333-
* validator.
334-
*
335-
* <p>
336-
* That means that this: <code>
332+
* When this is set to {@code false}, this: <code>
337333
* NimbusJwtDecoder jwtDecoder = NimbusJwtDecoder.withIssuerLocation(issuer).build();
338334
* jwtDecoder.setJwtValidator(JwtValidators.createDefaultWithIssuer(issuer);
339335
* </code>
@@ -600,21 +596,17 @@ private PublicKeyJwtDecoderBuilder(RSAPublicKey key) {
600596
}
601597

602598
/**
603-
* Whether to use Nimbus's typ header verification. This is {@code true} by
604-
* default, however it may change to {@code false} in a future major release.
599+
* Whether to use Nimbus's {@code typ} header verification. This is {@code false}
600+
* by default.
605601
*
606602
* <p>
607-
* By turning off this feature, {@link NimbusJwtDecoder} expects applications to
608-
* check the {@code typ} header themselves in order to determine what kind of
609-
* validation is needed
603+
* By turning on this feature, {@link NimbusJwtDecoder} will delegate checking the
604+
* {@code typ} header to Nimbus by using Nimbus's default
605+
* {@link JOSEObjectTypeVerifier}.
610606
* </p>
611607
*
612608
* <p>
613-
* This is done for you when you use {@link JwtValidators} to construct a
614-
* validator.
615-
*
616-
* <p>
617-
* That means that this: <code>
609+
* When this is set to {@code false}, this: <code>
618610
* NimbusJwtDecoder jwtDecoder = NimbusJwtDecoder.withIssuerLocation(issuer).build();
619611
* jwtDecoder.setJwtValidator(JwtValidators.createDefaultWithIssuer(issuer);
620612
* </code>
@@ -729,21 +721,17 @@ private SecretKeyJwtDecoderBuilder(SecretKey secretKey) {
729721
}
730722

731723
/**
732-
* Whether to use Nimbus's typ header verification. This is {@code true} by
733-
* default, however it may change to {@code false} in a future major release.
724+
* Whether to use Nimbus's {@code typ} header verification. This is {@code false}
725+
* by default.
734726
*
735727
* <p>
736-
* By turning off this feature, {@link NimbusJwtDecoder} expects applications to
737-
* check the {@code typ} header themselves in order to determine what kind of
738-
* validation is needed
728+
* By turning on this feature, {@link NimbusJwtDecoder} will delegate checking the
729+
* {@code typ} header to Nimbus by using Nimbus's default
730+
* {@link JOSEObjectTypeVerifier}.
739731
* </p>
740732
*
741733
* <p>
742-
* This is done for you when you use {@link JwtValidators} to construct a
743-
* validator.
744-
*
745-
* <p>
746-
* That means that this: <code>
734+
* When this is set to {@code false}, this: <code>
747735
* NimbusJwtDecoder jwtDecoder = NimbusJwtDecoder.withIssuerLocation(issuer).build();
748736
* jwtDecoder.setJwtValidator(JwtValidators.createDefaultWithIssuer(issuer);
749737
* </code>

0 commit comments

Comments
 (0)