1 package eu
.etaxonomy
.cdm
.api
.cache
;
5 import net
.sf
.ehcache
.config
.CacheConfiguration
;
6 import net
.sf
.ehcache
.config
.SizeOfPolicyConfiguration
;
8 import org
.springframework
.stereotype
.Component
;
10 import eu
.etaxonomy
.cdm
.api
.application
.CdmApplicationState
;
11 import eu
.etaxonomy
.cdm
.model
.common
.CdmBase
;
12 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTermBase
;
13 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CacheLoader
;
14 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CdmEntityCacheKey
;
15 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CdmTransientEntityCacher
;
16 import eu
.etaxonomy
.taxeditor
.service
.TermServiceRequestExecutor
;
17 import eu
.etaxonomy
.taxeditor
.session
.CdmEntitySession
;
18 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
19 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionManager
;
20 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionManagerObserver
;
23 * Class which uses CDM services to cache cdm entities
25 * FIXME: Currently only handles terms entities. It would be
26 * interesting to have a generic method which finds the
27 * correct service to load / cache the entity.
34 public class CdmServiceCacher
extends CdmCacher
implements ICdmEntitySessionManagerObserver
{
38 private ICdmEntitySessionManager cdmEntitySessionManager
;
40 private CdmTransientEntityCacher cdmTransientEntityCacher
;
42 private CacheLoader cacheLoader
;
45 protected void setup() {
46 DefinedTermBase
.setCacher(this);
47 CdmTransientEntityCacher
.setDefaultCacher(this);
48 TermServiceRequestExecutor
.setDefaultCacher(this);
50 cacheLoader
= new CacheLoader(this);
55 protected CacheConfiguration
getDefaultCacheConfiguration() {
56 // For a better understanding on how to size caches, refer to
57 // http://ehcache.org/documentation/configuration/cache-size
59 SizeOfPolicyConfiguration sizeOfConfig
= new SizeOfPolicyConfiguration();
60 sizeOfConfig
.setMaxDepth(100);
61 sizeOfConfig
.setMaxDepthExceededBehavior("abort");
63 return new CacheConfiguration(DEFAULT_CACHE_NAME
, 0)
66 .sizeOfPolicy(sizeOfConfig
)
67 .overflowToOffHeap(false);
72 protected CdmBase
findByUuid(UUID uuid
) {
73 CdmBase term
= CdmApplicationState
.getCurrentAppConfig().getTermService().findWithoutFlush(uuid
);
78 * @see eu.etaxonomy.cdm.model.ICdmCacher#isCachable(eu.etaxonomy.cdm.model.common.CdmBase)
81 public boolean isCachable(CdmBase cdmEntity
) {
82 if(cdmEntity
!= null && cdmEntity
instanceof DefinedTermBase
) {
89 public void setCdmEntitySessionManager(ICdmEntitySessionManager cdmEntitySessionManager
) {
90 this.cdmEntitySessionManager
= cdmEntitySessionManager
;
91 if(cdmEntitySessionManager
!= null) {
92 cdmEntitySessionManager
.addSessionObserver(this);
97 public CdmTransientEntityCacher
getCurrentCacher() {
98 ICdmEntitySession cdmEntitySession
= cdmEntitySessionManager
.getActiveSession();
99 if(cdmEntitySession
!= null && cdmEntitySession
instanceof CdmEntitySession
) {
100 return ((CdmEntitySession
) cdmEntitySession
).getCacher();
106 public CdmBase
getFromCache(CdmBase cdmBase
) {
107 CdmBase cachedCdmEntity
= null;
108 // first we check in the active session cache if the
109 // entity has been loaded there
110 // FIXME:Remoting do we really need the cdmTransientEntityCacher
111 // here. Is it not guarenteed that all every entity which 'isCachable'
112 // by this cacher is cached only in this cacher ?
113 if(!isCachable(cdmBase
) && cdmTransientEntityCacher
!= null) {
114 CdmEntityCacheKey key
= CdmTransientEntityCacher
.generateKey(cdmBase
);
115 cachedCdmEntity
= cdmTransientEntityCacher
.getFromCache(key
);
118 if(cachedCdmEntity
== null) {
119 cachedCdmEntity
= super.getFromCache(cdmBase
);
121 return cachedCdmEntity
;
126 * @see eu.etaxonomy.cdm.api.cache.CdmCacher#load(eu.etaxonomy.cdm.model.common.CdmBase)
129 public CdmBase
load(CdmBase cdmEntity
) {
130 CdmBase cachedCdmEntity
= getFromCache(cdmEntity
.getUuid());
132 if(isCachable(cdmEntity
) && cachedCdmEntity
== null) {
133 cachedCdmEntity
= cacheLoader
.load(cdmEntity
, false, true);
135 return cachedCdmEntity
;
139 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionManagerObserver#changed()
142 public void changed() {
143 ICdmEntitySession cdmEntitySession
= cdmEntitySessionManager
.getActiveSession();
144 if(cdmEntitySession
!= null && cdmEntitySession
instanceof CdmEntitySession
) {
145 this.cdmTransientEntityCacher
= ((CdmEntitySession
) cdmEntitySession
).getCacher();
147 this.cdmTransientEntityCacher
= null;