reorg components to fix circular dependencies

xuyanatsyxl · May 20, 2020 · 7c4302b · 7c4302b
1 parent 02f89c8
commit 7c4302b
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 36 deletions.
diff --git a/...cation/attribute/AttributeDefinition.java → ...cation/attribute/AttributeDefinition.java b/...cation/attribute/AttributeDefinition.java → ...cation/attribute/AttributeDefinition.java
diff --git a/...n/attribute/AttributeDefinitionStore.java → ...n/attribute/AttributeDefinitionStore.java b/...n/attribute/AttributeDefinitionStore.java → ...n/attribute/AttributeDefinitionStore.java
diff --git a/...ncipal/PrincipalAttributesRepository.java → ...ServicePrincipalAttributesRepository.java b/...ncipal/PrincipalAttributesRepository.java → ...ServicePrincipalAttributesRepository.java
@@ -24,7 +24,7 @@
  */
 @FunctionalInterface
 @JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
-public interface PrincipalAttributesRepository extends Serializable {
+public interface RegisteredServicePrincipalAttributesRepository extends Serializable {
 
     /**
      * Gets attributes for the given principal id.

diff --git a/...rvices/src/main/java/org/apereo/cas/services/RegisteredServiceAttributeReleasePolicy.java b/...rvices/src/main/java/org/apereo/cas/services/RegisteredServiceAttributeReleasePolicy.java
@@ -1,7 +1,7 @@
 package org.apereo.cas.services;
 
 import org.apereo.cas.authentication.principal.Principal;
-import org.apereo.cas.authentication.principal.PrincipalAttributesRepository;
+import org.apereo.cas.authentication.principal.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.Service;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -73,7 +73,7 @@ default RegisteredServiceConsentPolicy getConsentPolicy() {
      *
      * @return the principal attribute repository
      */
-    default PrincipalAttributesRepository getPrincipalAttributesRepository() {
+    default RegisteredServicePrincipalAttributesRepository getPrincipalAttributesRepository() {
         return null;
     }
 

diff --git a/...st/java/org/apereo/cas/authentication/attribute/DefaultAttributeDefinitionStoreTests.java b/...st/java/org/apereo/cas/authentication/attribute/DefaultAttributeDefinitionStoreTests.java
@@ -32,6 +32,7 @@ public class DefaultAttributeDefinitionStoreTests {
 
     @Test
     public void verifyAttrDefnNotFound() {
+        val service = CoreAuthenticationTestUtils.getRegisteredService();
         val store = new DefaultAttributeDefinitionStore();
         store.setScope("example.org");
         val defn = DefaultAttributeDefinition.builder()
@@ -41,12 +42,13 @@ public void verifyAttrDefnNotFound() {
             .build();
         store.registerAttributeDefinition(defn);
         var values = (Optional<Pair<AttributeDefinition, List<Object>>>) store.resolveAttributeValues("whatever",
-            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME));
+            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME), service);
         assertTrue(values.isEmpty());
     }
 
     @Test
     public void verifyAttributeDefinitionsAsMap() {
+        val service = CoreAuthenticationTestUtils.getRegisteredService();
         val store = new DefaultAttributeDefinitionStore();
         store.setScope("example.org");
         val defn = DefaultAttributeDefinition.builder()
@@ -56,7 +58,7 @@ public void verifyAttributeDefinitionsAsMap() {
             .build();
         store.registerAttributeDefinition(defn);
         assertFalse(store.isEmpty());
-        val attrs = store.resolveAttributeValues(CoreAuthenticationTestUtils.getAttributes());
+        val attrs = store.resolveAttributeValues(CoreAuthenticationTestUtils.getAttributes(), service);
         assertFalse(attrs.isEmpty());
         assertTrue(attrs.containsKey("mail"));
         assertTrue(attrs.containsKey(defn.getName()));
@@ -66,6 +68,7 @@ public void verifyAttributeDefinitionsAsMap() {
 
     @Test
     public void verifyScopedAttrDefn() {
+        val service = CoreAuthenticationTestUtils.getRegisteredService();
         val store = new DefaultAttributeDefinitionStore();
         store.setScope("example.org");
         val defn = DefaultAttributeDefinition.builder()
@@ -74,13 +77,15 @@ public void verifyScopedAttrDefn() {
             .scoped(true)
             .build();
         store.registerAttributeDefinition(defn);
-        var values = store.resolveAttributeValues("eduPersonPrincipalName", CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME));
+        var values = store.resolveAttributeValues("eduPersonPrincipalName",
+            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME), service);
         assertTrue(values.isPresent());
         assertTrue(values.get().getValue().contains("[email protected]"));
     }
 
     @Test
     public void verifyScriptedEmbeddedAttrDefn() {
+        val service = CoreAuthenticationTestUtils.getRegisteredService();
         val store = new DefaultAttributeDefinitionStore();
         store.setScope("example.org");
         val defn = DefaultAttributeDefinition.builder()
@@ -91,14 +96,15 @@ public void verifyScriptedEmbeddedAttrDefn() {
             .build();
         store.registerAttributeDefinition(defn);
         var values = store.resolveAttributeValues("eduPersonPrincipalName",
-            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME));
+            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME), service);
         assertTrue(values.isPresent());
         assertTrue(values.get().getValue().contains("[email protected]"));
         assertTrue(values.get().getValue().contains("[email protected]"));
     }
 
     @Test
     public void verifyScriptedExternalAttrDefn() {
+        val service = CoreAuthenticationTestUtils.getRegisteredService();
         val store = new DefaultAttributeDefinitionStore();
         store.setScope("system.org");
         val defn = DefaultAttributeDefinition.builder()
@@ -109,14 +115,15 @@ public void verifyScriptedExternalAttrDefn() {
             .build();
         store.registerAttributeDefinition(defn);
         var values = store.resolveAttributeValues("eduPersonPrincipalName",
-            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME));
+            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME), service);
         assertTrue(values.isPresent());
         assertTrue(values.get().getValue().contains("[email protected]"));
         assertTrue(values.get().getValue().contains("[email protected]"));
     }
 
     @Test
     public void verifyFormattedAttrDefn() {
+        val service = CoreAuthenticationTestUtils.getRegisteredService();
         val store = new DefaultAttributeDefinitionStore();
         store.setScope("example.org");
         val defn = DefaultAttributeDefinition.builder()
@@ -127,7 +134,7 @@ public void verifyFormattedAttrDefn() {
             .build();
         store.registerAttributeDefinition(defn);
         var values = store.resolveAttributeValues("eduPersonPrincipalName",
-            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME));
+            CollectionUtils.wrap(CoreAuthenticationTestUtils.CONST_USERNAME), service);
         assertTrue(values.isPresent());
         assertTrue(values.get().getValue().contains("hello,[email protected]"));
     }

diff --git a/core/cas-server-core-authentication-attributes/build.gradle b/core/cas-server-core-authentication-attributes/build.gradle
@@ -3,6 +3,7 @@ dependencies {
     implementation libraries.bouncycastle
 
     api project(":api:cas-server-core-api-services")
+    api project(":api:cas-server-core-api-authentication")
     api project(":api:cas-server-core-api-ticket")
     api project(":api:cas-server-core-api-events")
 

diff --git a/...in/java/org/apereo/cas/authentication/principal/DefaultPrincipalAttributesRepository.java b/...in/java/org/apereo/cas/authentication/principal/DefaultPrincipalAttributesRepository.java
@@ -2,7 +2,6 @@
 
 import org.apereo.cas.authentication.principal.cache.AbstractPrincipalAttributesRepository;
 import org.apereo.cas.services.RegisteredService;
-import org.apereo.cas.services.RegisteredServicePrincipalAttributesRepository;
 
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
@@ -26,12 +25,6 @@ public class DefaultPrincipalAttributesRepository extends AbstractPrincipalAttri
 
     private static final long serialVersionUID = -4535358847021241725L;
 
-    @Override
-    protected void addPrincipalAttributes(final String id, final Map<String, List<Object>> attributes,
-                                          final RegisteredService registeredService) {
-        LOGGER.debug("Using [{}], no caching takes place for [{}] to add attributes.", id, this.getClass().getSimpleName());
-    }
-
     @Override
     public Map<String, List<Object>> getAttributes(final Principal principal, final RegisteredService registeredService) {
         val mergeStrategy = determineMergingStrategy();
@@ -46,4 +39,10 @@ public Map<String, List<Object>> getAttributes(final Principal principal, final
         }
         return convertAttributesToPrincipalAttributesAndCache(principal, principalAttributes, registeredService);
     }
+
+    @Override
+    protected void addPrincipalAttributes(final String id, final Map<String, List<Object>> attributes,
+                                          final RegisteredService registeredService) {
+        LOGGER.debug("Using [{}], no caching takes place for [{}] to add attributes.", id, this.getClass().getSimpleName());
+    }
 }
diff --git a/.../org/apereo/cas/authentication/principal/cache/AbstractPrincipalAttributesRepository.java b/.../org/apereo/cas/authentication/principal/cache/AbstractPrincipalAttributesRepository.java
@@ -3,7 +3,7 @@
 import org.apereo.cas.authentication.AttributeMergingStrategy;
 import org.apereo.cas.authentication.attribute.PrincipalAttributeRepositoryFetcher;
 import org.apereo.cas.authentication.principal.Principal;
-import org.apereo.cas.services.RegisteredServicePrincipalAttributesRepository;
+import org.apereo.cas.authentication.principal.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.services.RegisteredService;
 import org.apereo.cas.util.CollectionUtils;
 import org.apereo.cas.util.spring.ApplicationContextProvider;
@@ -20,7 +20,6 @@
 import org.apereo.services.persondir.IPersonAttributeDao;
 
 import javax.persistence.Transient;
-
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
@@ -68,6 +67,13 @@ public abstract class AbstractPrincipalAttributesRepository implements Registere
     @Setter
     private boolean ignoreResolvedAttributes;
 
+    @Override
+    public abstract Map<String, List<Object>> getAttributes(Principal principal, RegisteredService registeredService);
+
+    @Override
+    public void close() {
+    }
+
     /**
      * Gets attribute repository.
      *
@@ -111,9 +117,6 @@ protected static Map<String, List<Object>> convertPersonAttributesToPrincipalAtt
             .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
     }
 
-    @Override
-    public abstract Map<String, List<Object>> getAttributes(Principal principal, RegisteredService registeredService);
-
     /**
      * Convert attributes to principal attributes and cache.
      *
@@ -197,8 +200,4 @@ protected Map<String, List<Object>> getPrincipalAttributes(final Principal princ
         }
         return convertPrincipalAttributesToPersonAttributes(principal.getAttributes());
     }
-
-    @Override
-    public void close() {
-    }
 }
diff --git a/...rc/main/java/org/apereo/cas/services/AbstractRegisteredServiceAttributeReleasePolicy.java b/...rc/main/java/org/apereo/cas/services/AbstractRegisteredServiceAttributeReleasePolicy.java
@@ -3,6 +3,7 @@
 import org.apereo.cas.authentication.attribute.AttributeDefinitionStore;
 import org.apereo.cas.authentication.principal.DefaultPrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.Principal;
+import org.apereo.cas.authentication.principal.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.Service;
 import org.apereo.cas.configuration.CasConfigurationProperties;
 import org.apereo.cas.services.consent.DefaultRegisteredServiceConsentPolicy;

diff --git a/...tion/src/main/java/org/apereo/cas/config/CasCoreAuthenticationPrincipalConfiguration.java b/...tion/src/main/java/org/apereo/cas/config/CasCoreAuthenticationPrincipalConfiguration.java
@@ -6,12 +6,12 @@
 import org.apereo.cas.authentication.principal.DefaultPrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.DefaultPrincipalElectionStrategy;
 import org.apereo.cas.authentication.principal.DefaultPrincipalResolutionExecutionPlan;
-import org.apereo.cas.services.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.PrincipalElectionStrategyConfigurer;
 import org.apereo.cas.authentication.principal.PrincipalFactory;
 import org.apereo.cas.authentication.principal.PrincipalFactoryUtils;
 import org.apereo.cas.authentication.principal.PrincipalResolutionExecutionPlanConfigurer;
 import org.apereo.cas.authentication.principal.PrincipalResolver;
+import org.apereo.cas.authentication.principal.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.resolvers.ChainingPrincipalResolver;
 import org.apereo.cas.authentication.principal.resolvers.EchoingPrincipalResolver;
@@ -60,7 +60,7 @@ public class CasCoreAuthenticationPrincipalConfiguration {
     @RefreshScope
     @Autowired
     public PrincipalElectionStrategy principalElectionStrategy(final List<PrincipalElectionStrategyConfigurer> configurers) {
-        LOGGER.trace("building principal election strategies from [{}]", configurers);
+        LOGGER.trace("Building principal election strategies from [{}]", configurers);
         val chain = new ChainingPrincipalElectionStrategy();
         AnnotationAwareOrderComparator.sortIfNecessary(configurers);
 
@@ -112,8 +112,7 @@ public PrincipalResolver personDirectoryAttributeRepositoryPrincipalResolver() {
     @RefreshScope
     @Autowired
     public PrincipalResolver defaultPrincipalResolver(final List<PrincipalResolutionExecutionPlanConfigurer> configurers,
-                                                      @Qualifier("principalElectionStrategy")
-                                                      final PrincipalElectionStrategy principalElectionStrategy) {
+                                                      @Qualifier("principalElectionStrategy") final PrincipalElectionStrategy principalElectionStrategy) {
         val plan = new DefaultPrincipalResolutionExecutionPlan();
         val sortedConfigurers = new ArrayList<PrincipalResolutionExecutionPlanConfigurer>(configurers);
         AnnotationAwareOrderComparator.sortIfNecessary(sortedConfigurers);
@@ -132,6 +131,7 @@ public PrincipalResolver defaultPrincipalResolver(final List<PrincipalResolution
 
     @ConditionalOnMissingBean(name = "casCorePrincipalResolutionExecutionPlanConfigurer")
     @Bean
+    @RefreshScope
     public PrincipalResolutionExecutionPlanConfigurer casCorePrincipalResolutionExecutionPlanConfigurer() {
         return plan -> {
             if (attributeRepositories.getObject().isEmpty()) {

diff --git a/...cas/authentication/principal/cache/AbstractCachingPrincipalAttributesRepositoryTests.java b/...cas/authentication/principal/cache/AbstractCachingPrincipalAttributesRepositoryTests.java
@@ -3,7 +3,6 @@
 import org.apereo.cas.authentication.AttributeMergingStrategy;
 import org.apereo.cas.authentication.CoreAuthenticationTestUtils;
 import org.apereo.cas.authentication.principal.Principal;
-import org.apereo.cas.services.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.PrincipalFactory;
 import org.apereo.cas.authentication.principal.PrincipalFactoryUtils;
 
@@ -29,7 +28,8 @@
 import static org.mockito.Mockito.*;
 
 /**
- * Parent class for test cases around {@link RegisteredServicePrincipalAttributesRepository}.
+ * Parent class for test cases around
+ * {@link org.apereo.cas.authentication.principal.RegisteredServicePrincipalAttributesRepository}.
  *
  * @author Misagh Moayyed
  * @since 4.2
@@ -71,8 +71,6 @@ public void initialize() {
         this.principal = this.principalFactory.createPrincipal("uid", Collections.singletonMap(MAIL, email));
     }
 
-    protected abstract AbstractPrincipalAttributesRepository getPrincipalAttributesRepository(String unit, long duration);
-
     @Test
     @SneakyThrows
     public void checkExpiredCachedAttributes() {
@@ -142,4 +140,6 @@ public void verifyMergingStrategyWithMultivaluedAttributeMerger() {
             assertTrue(mailAttr.contains("[email protected]"));
         }
     }
+
+    protected abstract AbstractPrincipalAttributesRepository getPrincipalAttributesRepository(String unit, long duration);
 }
diff --git a/...rver-core/src/test/java/org/apereo/cas/config/CasRegisteredServicesTestConfiguration.java b/...rver-core/src/test/java/org/apereo/cas/config/CasRegisteredServicesTestConfiguration.java
@@ -2,7 +2,7 @@
 
 import org.apereo.cas.TestOneTimePasswordAuthenticationHandler;
 import org.apereo.cas.authentication.AcceptUsersAuthenticationHandler;
-import org.apereo.cas.services.RegisteredServicePrincipalAttributesRepository;
+import org.apereo.cas.authentication.principal.RegisteredServicePrincipalAttributesRepository;
 import org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository;
 import org.apereo.cas.services.AnonymousRegisteredServiceUsernameAttributeProvider;
 import org.apereo.cas.services.DefaultRegisteredServiceAccessStrategy;

diff --git a/...cket-registry/src/main/java/org/apereo/cas/config/EhcacheTicketRegistryConfiguration.java b/...cket-registry/src/main/java/org/apereo/cas/config/EhcacheTicketRegistryConfiguration.java
@@ -23,8 +23,6 @@
 import net.sf.ehcache.distribution.RMISynchronousCacheReplicator;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
-import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
-import org.springframework.boot.actuate.cache.CachesEndpoint;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;