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
.cdm
.model
.common
.TermBase
;
14 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CacheLoader
;
15 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CdmEntityCacheKey
;
16 import eu
.etaxonomy
.taxeditor
.remoting
.cache
.CdmTransientEntityCacher
;
17 import eu
.etaxonomy
.taxeditor
.service
.TermServiceRequestExecutor
;
18 import eu
.etaxonomy
.taxeditor
.session
.CdmEntitySession
;
19 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySession
;
20 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionManager
;
21 import eu
.etaxonomy
.taxeditor
.session
.ICdmEntitySessionManagerObserver
;
24 * Class which uses CDM services to cache cdm entities
26 * FIXME: Currently only handles terms entities. It would be
27 * interesting to have a generic method which finds the
28 * correct service to load / cache the entity.
35 public class CdmServiceCacher
extends CdmCacher
implements ICdmEntitySessionManagerObserver
{
39 private ICdmEntitySessionManager cdmEntitySessionManager
;
41 private CdmTransientEntityCacher cdmTransientEntityCacher
;
43 private CacheLoader cacheLoader
;
46 protected void setup() {
47 DefinedTermBase
.setCacher(this);
48 CdmTransientEntityCacher
.setDefaultCacher(this);
49 TermServiceRequestExecutor
.setDefaultCacher(this);
51 cacheLoader
= new CacheLoader(this);
56 protected CacheConfiguration
getDefaultCacheConfiguration() {
57 // For a better understanding on how to size caches, refer to
58 // http://ehcache.org/documentation/configuration/cache-size
60 SizeOfPolicyConfiguration sizeOfConfig
= new SizeOfPolicyConfiguration();
61 sizeOfConfig
.setMaxDepth(100);
62 sizeOfConfig
.setMaxDepthExceededBehavior("abort");
64 return new CacheConfiguration(DEFAULT_CACHE_NAME
, 0)
67 .sizeOfPolicy(sizeOfConfig
)
68 .overflowToOffHeap(false);
73 protected CdmBase
findByUuid(UUID uuid
) {
74 CdmBase term
= CdmApplicationState
.getCurrentAppConfig().getTermService().findWithoutFlush(uuid
);
79 * @see eu.etaxonomy.cdm.model.ICdmCacher#isCachable(eu.etaxonomy.cdm.model.common.CdmBase)
82 public boolean isCachable(CdmBase cdmEntity
) {
83 // if(cdmEntity != null && cdmEntity instanceof DefinedTermBase) {
84 if(cdmEntity
!= null && cdmEntity
instanceof TermBase
) {
91 public void setCdmEntitySessionManager(ICdmEntitySessionManager cdmEntitySessionManager
) {
92 this.cdmEntitySessionManager
= cdmEntitySessionManager
;
93 if(cdmEntitySessionManager
!= null) {
94 cdmEntitySessionManager
.addSessionObserver(this);
99 public CdmTransientEntityCacher
getCurrentCacher() {
100 ICdmEntitySession cdmEntitySession
= cdmEntitySessionManager
.getActiveSession();
101 if(cdmEntitySession
!= null && cdmEntitySession
instanceof CdmEntitySession
) {
102 return ((CdmEntitySession
) cdmEntitySession
).getCacher();
108 public CdmBase
getFromCache(CdmBase cdmBase
) {
109 CdmBase cachedCdmEntity
= null;
110 // first we check in the active session cache if the
111 // entity has been loaded there
112 // FIXME:Remoting do we really need the cdmTransientEntityCacher
113 // here. Is it not guarenteed that all every entity which 'isCachable'
114 // by this cacher is cached only in this cacher ?
115 if(!isCachable(cdmBase
) && cdmTransientEntityCacher
!= null) {
116 CdmEntityCacheKey key
= CdmTransientEntityCacher
.generateKey(cdmBase
);
117 cachedCdmEntity
= cdmTransientEntityCacher
.getFromCache(key
);
120 if(cachedCdmEntity
== null) {
121 cachedCdmEntity
= super.getFromCache(cdmBase
);
123 return cachedCdmEntity
;
128 * @see eu.etaxonomy.cdm.api.cache.CdmCacher#load(eu.etaxonomy.cdm.model.common.CdmBase)
131 public CdmBase
load(CdmBase cdmEntity
) {
132 CdmBase cachedCdmEntity
= getFromCache(cdmEntity
.getUuid());
134 if(isCachable(cdmEntity
) && cachedCdmEntity
== null) {
135 cachedCdmEntity
= cacheLoader
.load(cdmEntity
, false, true);
137 return cachedCdmEntity
;
141 * @see eu.etaxonomy.taxeditor.session.ICdmEntitySessionManagerObserver#changed()
144 public void changed() {
145 ICdmEntitySession cdmEntitySession
= cdmEntitySessionManager
.getActiveSession();
146 if(cdmEntitySession
!= null && cdmEntitySession
instanceof CdmEntitySession
) {
147 this.cdmTransientEntityCacher
= ((CdmEntitySession
) cdmEntitySession
).getCacher();
149 this.cdmTransientEntityCacher
= null;