cleanup and renaming for caching
authorAndreas Müller <a.mueller@bgbm.org>
Wed, 21 Dec 2022 10:27:06 +0000 (11:27 +0100)
committerAndreas Müller <a.mueller@bgbm.org>
Wed, 21 Dec 2022 10:43:18 +0000 (11:43 +0100)
eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/cdm/api/application/CdmApplicationState.java
eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/cdm/api/cache/CdmServiceCachingProxy.java [moved from eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/cdm/api/cache/CdmServiceCacher.java with 94% similarity]
eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/taxeditor/service/RemoteInvocationTermCacher.java
eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/store/CdmStore.java
eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/view/sessions/SessionsViewPart.java
eu.etaxonomy.taxeditor.test/src/test/java/eu/etaxonomy/taxeditor/httpinvoker/BaseRemotingTest.java
eu.etaxonomy.taxeditor.test/src/test/java/eu/etaxonomy/taxeditor/lazyloading/CdmServiceCacherTest.java
eu.etaxonomy.taxeditor.test/src/test/java/eu/etaxonomy/taxeditor/service/ServiceInterceptorTest.java

index 4941c2e9f591a786f2f538ab926a147530a8a614..7b4dea137cf3d60ab63b10cf76dddb065918d07e 100644 (file)
@@ -28,7 +28,7 @@ import org.osgi.framework.BundleException;
 import org.osgi.framework.Constants;
 import org.springframework.security.core.context.SecurityContext;
 
-import eu.etaxonomy.cdm.api.cache.CdmServiceCacher;
+import eu.etaxonomy.cdm.api.cache.CdmServiceCachingProxy;
 import eu.etaxonomy.cdm.api.service.ICommonService;
 import eu.etaxonomy.cdm.api.service.IService;
 import eu.etaxonomy.cdm.api.service.ITestService;
@@ -54,7 +54,7 @@ public class CdmApplicationState {
     //FIXME SecurityContextHolder.getContext()
     private SecurityContext securityContext;
 
-    private static CdmServiceCacher cdmServiceCacher;
+    private static CdmServiceCachingProxy termProxy;
 
     private static String cdmlibVersion = null;
     private static String cdmlibLastModified = null;
@@ -117,7 +117,7 @@ public class CdmApplicationState {
         getInstance().setAppConfig(null);
         getInstance().setSecurityContext(null);
         cdmApplicationState = null;
-        cdmServiceCacher = null;
+        termProxy = null;
         cdmlibVersion = null;
         cdmlibLastModified = null;
     }
@@ -185,12 +185,12 @@ public class CdmApplicationState {
         return ((CdmApplicationRemoteController)configuration).getCachedCommonService();
     }
 
-    public static CdmServiceCacher getCdmServiceCacher() {
-        return cdmServiceCacher;
+    public static CdmServiceCachingProxy getTermProxy() {
+        return termProxy;
     }
 
-    public static void setCdmServiceCacher(CdmServiceCacher cacher) {
-        cdmServiceCacher = cacher;
+    public static void setTermProxy(CdmServiceCachingProxy cacher) {
+        termProxy = cacher;
     }
 
     public static void updateCdmlibManifestInfo() {
similarity index 94%
rename from eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/cdm/api/cache/CdmServiceCacher.java
rename to eu.etaxonomy.taxeditor.cdmlib/src/main/java/eu/etaxonomy/cdm/api/cache/CdmServiceCachingProxy.java
index 7c6fe9cab2bb9643e112c8db99cf78acd1a86567..2a6815d47f470c6f09f0b3e817e406c9f4ca8571 100644 (file)
@@ -38,10 +38,13 @@ import net.sf.ehcache.config.SizeOfPolicyConfiguration;
  * FIXME: Currently only handles term entities. It would be
  *        interesting to have a generic method which finds the
  *        correct service to load / cache the entity.
+ * TODO by AM: compare with {@link CdmTermCacher} and merge if possible
  *
  * @author cmathew
  */
-public class CdmServiceCacher extends CdmCacherBase implements ICdmEntitySessionManagerObserver {
+public class CdmServiceCachingProxy
+        extends CdmCacherBase
+        implements ICdmEntitySessionManagerObserver {
 
     private ICdmEntitySessionManager cdmEntitySessionManager;
 
@@ -88,7 +91,7 @@ public class CdmServiceCacher extends CdmCacherBase implements ICdmEntitySession
         diskStoreConfiguration.setPath(ehcacheFolder.getAbsolutePath());
 
         cacheConfig.setDiskStoreConfiguration(diskStoreConfiguration);
-        addCacheManager(cacheConfig.cacheManager());
+        setCacheManager(cacheConfig.cacheManager());
     }
 
     @Override
@@ -113,6 +116,9 @@ public class CdmServiceCacher extends CdmCacherBase implements ICdmEntitySession
         return load(term);
     }
 
+    /**
+     * <code>true</code> if the parameter is a term or a representation
+     */
     @Override
     public boolean isCachable(CdmBase cdmEntity) {
        if(cdmEntity == null){
@@ -145,7 +151,7 @@ public class CdmServiceCacher extends CdmCacherBase implements ICdmEntitySession
         // first we check in the active session cache if the
         // entity has been loaded there
         // FIXME:Remoting do we really need the cdmTransientEntityCacher
-        // here. Is it not guaranteed that all every entity which 'isCachable'
+        // here. Is it not guaranteed that every entity which 'isCachable'
         // by this cacher is cached only in this cacher ?
         if(!isCachable(cdmBase) && cdmTransientEntityCacher != null) {
             CdmEntityCacheKey<T> key = CdmTransientEntityCacher.generateKey(cdmBase);
index 8832a57a39a65331512b81b914f91b5982ec89ab..53f666287360e60763332a08ba413a6210e823bd 100644 (file)
@@ -19,7 +19,7 @@ import org.apache.logging.log4j.Logger;
 import org.springframework.remoting.support.RemoteInvocation;
 import org.springframework.remoting.support.RemoteInvocationResult;
 
-import eu.etaxonomy.cdm.api.cache.CdmServiceCacher;
+import eu.etaxonomy.cdm.api.cache.CdmServiceCachingProxy;
 import eu.etaxonomy.cdm.model.term.DefinedTermBase;
 import eu.etaxonomy.cdm.model.term.TermType;
 
@@ -34,9 +34,9 @@ public class RemoteInvocationTermCacher implements IRemoteInvocationTermCacher {
 
        private static Map<TermType, RemoteInvocationResult> termTypeMap = new HashMap<>();
 
-       private static CdmServiceCacher cdmServiceCacher;
+       private static CdmServiceCachingProxy cdmServiceCacher;
 
-       public static void setDefaultCacher(CdmServiceCacher csc) {
+       public static void setDefaultCacher(CdmServiceCachingProxy csc) {
         cdmServiceCacher = csc;
     }
 
index 06376caaba20cbfd7f8025b97a3f023fc95d15e5..1e54f916006fed572cadcc59701029bfba73e2c7 100644 (file)
@@ -26,7 +26,7 @@ import eu.etaxonomy.cdm.api.application.CdmApplicationException;
 import eu.etaxonomy.cdm.api.application.CdmApplicationRemoteController;
 import eu.etaxonomy.cdm.api.application.CdmApplicationState;
 import eu.etaxonomy.cdm.api.application.ICdmRepository;
-import eu.etaxonomy.cdm.api.cache.CdmServiceCacher;
+import eu.etaxonomy.cdm.api.cache.CdmServiceCachingProxy;
 import eu.etaxonomy.cdm.api.service.IAgentService;
 import eu.etaxonomy.cdm.api.service.IAnnotationService;
 import eu.etaxonomy.cdm.api.service.IClassificationService;
@@ -277,7 +277,7 @@ public class CdmStore {
     public static void setInstance(CdmApplicationRemoteController applicationController,
             ICdmSource cdmSource) {
         instance = new CdmStore(applicationController, cdmSource);
-        CdmApplicationState.setCdmServiceCacher(new CdmServiceCacher());
+        CdmApplicationState.setTermProxy(new CdmServiceCachingProxy());
     }
 
     protected CdmStore(CdmApplicationRemoteController repository,
@@ -290,8 +290,6 @@ public class CdmStore {
 
     /**
      * All calls to the datastore require
-     *
-     * @return
      */
     private CdmApplicationRemoteController getApplicationConfiguration() {
         try {
index ec7994803b2bc546856a5c06e9a72533b66fe5ee..dbce3d428daddbaa519fbc96095b4a781916206b 100644 (file)
@@ -295,7 +295,6 @@ public class SessionsViewPart implements ICdmEntitySessionManagerObserver {
             txtCdmModelInMemory.setText(getInMemoryStats(liveCacheStatistics));
             txtCdmModelOnDisk.setText(getOnDiskStats(liveCacheStatistics));
         }
-
     }
 
     private void addSession(ICdmEntitySession session) {
index e4b4cecc607ff94b07067f7ee07e8bce5fd6155a..38a79aebaf85cdb5a4463925c838b4706b01a20c 100644 (file)
@@ -25,7 +25,7 @@ import org.unitils.spring.annotation.SpringApplicationContext;
 import eu.etaxonomy.cdm.api.application.CdmApplicationRemoteController;
 import eu.etaxonomy.cdm.api.application.CdmApplicationState;
 import eu.etaxonomy.cdm.api.application.CdmDataChangeService;
-import eu.etaxonomy.cdm.api.cache.CdmServiceCacher;
+import eu.etaxonomy.cdm.api.cache.CdmServiceCachingProxy;
 import eu.etaxonomy.cdm.cache.CdmRemoteCacheManager;
 import eu.etaxonomy.cdm.model.permission.User;
 import eu.etaxonomy.taxeditor.remoting.cache.ConversationalTransientEntityCacher;
@@ -93,7 +93,7 @@ public abstract class BaseRemotingTest extends ThreadedTest {
                         null,
                         null);
         CdmApplicationState.setCurrentAppConfig(remoteApplicationController);
-        CdmApplicationState.setCdmServiceCacher(new CdmServiceCacher());
+        CdmApplicationState.setTermProxy(new CdmServiceCachingProxy());
 
         cdmEntitySessionManager = getRemoteApplicationController().getCdmEntitySessionManager();
 
index a421684329d3765d957f54d2a5f1e30aaad5dcc6..bef18b1b2f48a50ed2457735c8c51edad82b5ec9 100644 (file)
@@ -14,7 +14,7 @@ import org.junit.Assert;
 import org.junit.Test;
 
 import eu.etaxonomy.cdm.api.application.CdmApplicationState;
-import eu.etaxonomy.cdm.api.cache.CdmServiceCacher;
+import eu.etaxonomy.cdm.api.cache.CdmServiceCachingProxy;
 import eu.etaxonomy.cdm.model.common.Language;
 import eu.etaxonomy.taxeditor.httpinvoker.RemotingSessionAwareTest;
 
@@ -23,7 +23,7 @@ public class CdmServiceCacherTest extends RemotingSessionAwareTest {
     @SuppressWarnings("unused")
     private static final Logger logger = LogManager.getLogger(CdmServiceCacherTest.class);
 
-       private static CdmServiceCacher cdmServiceCacher = CdmApplicationState.getCdmServiceCacher();
+       private static CdmServiceCachingProxy cdmServiceCacher = CdmApplicationState.getTermProxy();
 
        @Test
        public void testLanguageCache() {
index 3bea4b29df2765a747817b117cee2e96ad4eb3da..5ba1adbe02b1544d48c2975a3278a0edce215dcd 100644 (file)
@@ -9,7 +9,7 @@ import org.junit.Assert;
 import org.junit.Test;
 
 import eu.etaxonomy.cdm.api.application.CdmApplicationState;
-import eu.etaxonomy.cdm.api.cache.CdmServiceCacher;
+import eu.etaxonomy.cdm.api.cache.CdmServiceCachingProxy;
 import eu.etaxonomy.cdm.api.service.ITermService;
 import eu.etaxonomy.cdm.model.common.CdmBase;
 import eu.etaxonomy.cdm.model.common.Language;
@@ -22,7 +22,7 @@ public class ServiceInterceptorTest extends RemotingSessionAwareTest {
         @SuppressWarnings("unused")
     private static final Logger logger = LogManager.getLogger(ServiceInterceptorTest.class);
         private final ITermService termService = getRemoteApplicationController().getTermService();
-        private static CdmServiceCacher cdmServiceCacher = CdmApplicationState.getCdmServiceCacher();
+        private static CdmServiceCachingProxy cdmServiceCacher = CdmApplicationState.getTermProxy();
 
 
            @Test