From d52edb8f769891811358bda27bf188a6bc200e6a Mon Sep 17 00:00:00 2001 From: Joe Grandja Date: Mon, 20 Nov 2023 10:49:26 -0500 Subject: [PATCH] Update javadoc for JDBC implementations --- .../JdbcOAuth2AuthorizationConsentService.java | 10 ++++++++-- .../authorization/JdbcOAuth2AuthorizationService.java | 10 ++++++++-- .../client/JdbcRegisteredClientRepository.java | 10 ++++++++-- 3 files changed, 24 insertions(+), 6 deletions(-) diff --git a/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationConsentService.java b/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationConsentService.java index e489fc0a..24ca449e 100644 --- a/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationConsentService.java +++ b/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationConsentService.java @@ -1,5 +1,5 @@ /* - * Copyright 2020-2021 the original author or authors. + * Copyright 2020-2023 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -43,11 +43,17 @@ import org.springframework.util.StringUtils; * {@link JdbcOperations} for {@link OAuth2AuthorizationConsent} persistence. * *

- * NOTE: This {@code OAuth2AuthorizationConsentService} depends on the table definition + * IMPORTANT: This {@code OAuth2AuthorizationConsentService} depends on the table definition * described in * "classpath:org/springframework/security/oauth2/server/authorization/oauth2-authorization-consent-schema.sql" and * therefore MUST be defined in the database schema. * + *

+ * NOTE: This {@code OAuth2AuthorizationConsentService} is a simplified JDBC implementation that MAY be used in a production environment. + * However, it does have limitations as it likely won't perform well in an environment requiring high throughput. + * The expectation is that the consuming application will provide their own implementation of {@code OAuth2AuthorizationConsentService} + * that meets the performance requirements for its deployment environment. + * * @author Ovidiu Popa * @since 0.1.2 * @see OAuth2AuthorizationConsentService diff --git a/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationService.java b/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationService.java index e053a99c..24580254 100644 --- a/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationService.java +++ b/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/JdbcOAuth2AuthorizationService.java @@ -1,5 +1,5 @@ /* - * Copyright 2020-2022 the original author or authors. + * Copyright 2020-2023 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -65,11 +65,17 @@ import org.springframework.util.StringUtils; * {@link JdbcOperations} for {@link OAuth2Authorization} persistence. * *

- * NOTE: This {@code OAuth2AuthorizationService} depends on the table definition + * IMPORTANT: This {@code OAuth2AuthorizationService} depends on the table definition * described in * "classpath:org/springframework/security/oauth2/server/authorization/oauth2-authorization-schema.sql" and * therefore MUST be defined in the database schema. * + *

+ * NOTE: This {@code OAuth2AuthorizationService} is a simplified JDBC implementation that MAY be used in a production environment. + * However, it does have limitations as it likely won't perform well in an environment requiring high throughput. + * The expectation is that the consuming application will provide their own implementation of {@code OAuth2AuthorizationService} + * that meets the performance requirements for its deployment environment. + * * @author Ovidiu Popa * @author Joe Grandja * @since 0.1.2 diff --git a/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/client/JdbcRegisteredClientRepository.java b/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/client/JdbcRegisteredClientRepository.java index 32e2442b..3d2ca44e 100644 --- a/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/client/JdbcRegisteredClientRepository.java +++ b/oauth2-authorization-server/src/main/java/org/springframework/security/oauth2/server/authorization/client/JdbcRegisteredClientRepository.java @@ -1,5 +1,5 @@ /* - * Copyright 2020-2022 the original author or authors. + * Copyright 2020-2023 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -52,10 +52,16 @@ import org.springframework.util.StringUtils; * {@link JdbcOperations} for {@link RegisteredClient} persistence. * *

- * NOTE: This {@code RegisteredClientRepository} depends on the table definition described in + * IMPORTANT: This {@code RegisteredClientRepository} depends on the table definition described in * "classpath:org/springframework/security/oauth2/server/authorization/client/oauth2-registered-client-schema.sql" and * therefore MUST be defined in the database schema. * + *

+ * NOTE: This {@code RegisteredClientRepository} is a simplified JDBC implementation that MAY be used in a production environment. + * However, it does have limitations as it likely won't perform well in an environment requiring high throughput. + * The expectation is that the consuming application will provide their own implementation of {@code RegisteredClientRepository} + * that meets the performance requirements for its deployment environment. + * * @author Rafal Lewczuk * @author Joe Grandja * @author Ovidiu Popa