Polish "How-to: Implement core services with JPA"

Issue gh-545

Author: Steve Riesenberg

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/Authorization.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/entity/authorization/Authorization.java

@@ -13,18 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.entity.authorization;
 
 import java.time.Instant;
 
 import javax.persistence.Column;
 import javax.persistence.Entity;
 import javax.persistence.Id;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Entity
 public class Authorization {
 	@Id
@@ -69,8 +65,7 @@ public class Authorization {
 	@Column(length = 2000)
 	private String oidcIdTokenClaims;
 
-	// getters and setters
-// end::class[]
+	// @fold:on
 	public String getId() {
 		return id;
 	}
@@ -270,6 +265,5 @@ public String getOidcIdTokenClaims() {
 	public void setOidcIdTokenClaims(String idTokenClaims) {
 		this.oidcIdTokenClaims = idTokenClaims;
 	}
-// tag::class[]
+	// @fold:off
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/AuthorizationConsent.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/entity/authorizationConsent/AuthorizationConsent.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.entity.authorizationConsent;
 
 import java.io.Serializable;
 import java.util.Objects;
@@ -23,10 +23,6 @@
 import javax.persistence.Id;
 import javax.persistence.IdClass;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Entity
 @IdClass(AuthorizationConsent.AuthorizationConsentId.class)
 public class AuthorizationConsent {
@@ -37,8 +33,7 @@ public class AuthorizationConsent {
 	@Column(length = 1000)
 	private String authorities;
 
-	// getters and setters
-// end::class[]
+	// @fold:on
 	public String getRegisteredClientId() {
 		return registeredClientId;
 	}
@@ -62,14 +57,13 @@ public String getAuthorities() {
 	public void setAuthorities(String authorities) {
 		this.authorities = authorities;
 	}
-// tag::class[]
+	// @fold:off
 
 	public static class AuthorizationConsentId implements Serializable {
 		private String registeredClientId;
 		private String principalName;
 
-		// getters and setters
-// end::class[]
+		// @fold:on
 		public String getRegisteredClientId() {
 			return registeredClientId;
 		}
@@ -85,10 +79,8 @@ public String getPrincipalName() {
 		public void setPrincipalName(String principalName) {
 			this.principalName = principalName;
 		}
-// tag::class[]
+		// @fold:off
 
-		// equals and hashCode
-// end::class[]
 		@Override
 		public boolean equals(Object o) {
 			if (this == o) return true;
@@ -101,7 +93,5 @@ public boolean equals(Object o) {
 		public int hashCode() {
 			return Objects.hash(registeredClientId, principalName);
 		}
-// tag::class[]
 	}
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/Client.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/entity/client/Client.java

@@ -13,18 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.entity.client;
 
 import java.time.Instant;
 
 import javax.persistence.Column;
 import javax.persistence.Entity;
 import javax.persistence.Id;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Entity
 public class Client {
 	@Id
@@ -47,8 +43,7 @@ public class Client {
 	@Column(length = 2000)
 	private String tokenSettings;
 
-	// getters and setters
-// end::class[]
+	// @fold:on
 	public String getId() {
 		return id;
 	}
@@ -144,6 +139,5 @@ public String getTokenSettings() {
 	public void setTokenSettings(String tokenSettings) {
 		this.tokenSettings = tokenSettings;
 	}
-// tag::class[]
+	// @fold:off
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/AuthorizationRepository.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/repository/authorization/AuthorizationRepository.java

@@ -13,19 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.repository.authorization;
 
 import java.util.Optional;
 
+import sample.jpa.entity.authorization.Authorization;
+
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.repository.query.Param;
 import org.springframework.stereotype.Repository;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Repository
 public interface AuthorizationRepository extends JpaRepository<Authorization, String> {
 	Optional<Authorization> findByState(String state);
@@ -39,4 +37,3 @@ public interface AuthorizationRepository extends JpaRepository<Authorization, St
 	)
 	Optional<Authorization> findByStateOrAuthorizationCodeValueOrAccessTokenValueOrRefreshTokenValue(@Param("token") String token);
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/AuthorizationConsentRepository.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/repository/authorizationConsent/AuthorizationConsentRepository.java

@@ -13,20 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.repository.authorizationConsent;
 
 import java.util.Optional;
 
+import sample.jpa.entity.authorizationConsent.AuthorizationConsent;
+
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Repository
 public interface AuthorizationConsentRepository extends JpaRepository<AuthorizationConsent, AuthorizationConsent.AuthorizationConsentId> {
 	Optional<AuthorizationConsent> findByRegisteredClientIdAndPrincipalName(String registeredClientId, String principalName);
 	void deleteByRegisteredClientIdAndPrincipalName(String registeredClientId, String principalName);
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/ClientRepository.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/repository/client/ClientRepository.java

@@ -13,19 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.repository.client;
 
 import java.util.Optional;
 
+import sample.jpa.entity.client.Client;
+
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.stereotype.Repository;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Repository
 public interface ClientRepository extends JpaRepository<Client, String> {
 	Optional<Client> findByClientId(String clientId);
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/JpaOAuth2AuthorizationService.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/service/authorization/JpaOAuth2AuthorizationService.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.service.authorization;
 
 import java.time.Instant;
 import java.util.List;
@@ -24,6 +24,8 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import sample.jpa.entity.authorization.Authorization;
+import sample.jpa.repository.authorization.AuthorizationRepository;
 
 import org.springframework.dao.DataRetrievalFailureException;
 import org.springframework.security.jackson2.SecurityJackson2Modules;
@@ -44,10 +46,6 @@
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Component
 public class JpaOAuth2AuthorizationService implements OAuth2AuthorizationService {
 	private final AuthorizationRepository authorizationRepository;
@@ -261,4 +259,3 @@ private static AuthorizationGrantType resolveAuthorizationGrantType(String autho
 		return new AuthorizationGrantType(authorizationGrantType);              // Custom authorization grant type
 	}
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/JpaOAuth2AuthorizationConsentService.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/service/authorizationConsent/JpaOAuth2AuthorizationConsentService.java

@@ -13,11 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.service.authorizationConsent;
 
 import java.util.HashSet;
 import java.util.Set;
 
+import sample.jpa.entity.authorizationConsent.AuthorizationConsent;
+import sample.jpa.repository.authorizationConsent.AuthorizationConsentRepository;
+
 import org.springframework.dao.DataRetrievalFailureException;
 import org.springframework.security.core.GrantedAuthority;
 import org.springframework.security.core.authority.SimpleGrantedAuthority;
@@ -29,10 +32,6 @@
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Component
 public class JpaOAuth2AuthorizationConsentService implements OAuth2AuthorizationConsentService {
 	private final AuthorizationConsentRepository authorizationConsentRepository;
@@ -99,4 +98,3 @@ private AuthorizationConsent toEntity(OAuth2AuthorizationConsent authorizationCo
 		return entity;
 	}
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/JpaRegisteredClientRepository.java renamed to docs/src/docs/asciidoc/examples/src/main/java/sample/jpa/service/client/JpaRegisteredClientRepository.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package sample.jpa;
+package sample.jpa.service.client;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -23,6 +23,8 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.Module;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import sample.jpa.entity.client.Client;
+import sample.jpa.repository.client.ClientRepository;
 
 import org.springframework.security.jackson2.SecurityJackson2Modules;
 import org.springframework.security.oauth2.core.AuthorizationGrantType;
@@ -36,10 +38,6 @@
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
 
-/**
- * @author Steve Riesenberg
- */
-// tag::class[]
 @Component
 public class JpaRegisteredClientRepository implements RegisteredClientRepository {
 	private final ClientRepository clientRepository;
@@ -172,4 +170,3 @@ private static ClientAuthenticationMethod resolveClientAuthenticationMethod(Stri
 		return new ClientAuthenticationMethod(clientAuthenticationMethod);      // Custom client authentication method
 	}
 }
-// end::class[]

docs/src/docs/asciidoc/examples/src/main/resources/oauth2-authorization-consent-schema.sql

@@ -26,6 +26,9 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import sample.AuthorizationCodeGrantFlow;
 import sample.jose.TestJwks;
+import sample.jpa.service.authorization.JpaOAuth2AuthorizationService;
+import sample.jpa.service.authorizationConsent.JpaOAuth2AuthorizationConsentService;
+import sample.jpa.service.client.JpaRegisteredClientRepository;
 import sample.test.SpringTestContext;
 import sample.test.SpringTestContextExtension;