Clover icon

Magnolia Module Cache 5.5.9

  1. Project Clover database Mon Nov 25 2019 16:46:50 CET
  2. Package info.magnolia.module.cache.blocking

File AbstractBlockingCache.java

 

Coverage histogram

../../../../../img/srcFileCovDistChart0.png
75% of files have more coverage

Code metrics

14
38
8
1
150
98
16
0.42
4.75
8
2
6.2% of code in this file is excluded from these metrics.

Classes

Class Line # Actions
AbstractBlockingCache 47 38 6.2% 16 60
0.00%
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /**
2    * This file Copyright (c) 2017-2018 Magnolia International
3    * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10    * This file is distributed in the hope that it will be
11    * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12    * implied warranty of MERCHANTABILITY or FITNESS FOR A
13    * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14    * Redistribution, except as permitted by whichever of the GPL
15    * or MNA you select, is prohibited.
16    *
17    * 1. For the GPL license (GPL), you can redistribute and/or
18    * modify this file under the terms of the GNU General
19    * Public License, Version 3, as published by the Free Software
20    * Foundation. You should have received a copy of the GNU
21    * General Public License, Version 3 along with this program;
22    * if not, write to the Free Software Foundation, Inc., 51
23    * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24    *
25    * 2. For the Magnolia Network Agreement (MNA), this file
26    * and the accompanying materials are made available under the
27    * terms of the MNA which accompanies this distribution, and
28    * is available at http://www.magnolia-cms.com/mna.html
29    *
30    * Any modifications to this file must keep this entire header
31    * intact.
32    *
33    */
34    package info.magnolia.module.cache.blocking;
35   
36    import info.magnolia.module.cache.BlockingCache;
37    import info.magnolia.module.cache.CacheModule;
38    import info.magnolia.cache.concurrent.LockType;
39    import info.magnolia.cache.concurrent.ReadWriteLockSync;
40    import info.magnolia.cache.concurrent.StripedReadWriteLockSync;
41    import info.magnolia.module.cache.exception.MgnlLockTimeoutException;
42    import info.magnolia.module.cache.listeners.AbstractListeningCacheWrapper;
43   
44    /**
45    * Abstract implementation of {@link info.magnolia.module.cache.BlockingCache}.
46    */
 
47    public abstract class AbstractBlockingCache extends AbstractListeningCacheWrapper implements BlockingCache {
48   
49    private volatile int blockingTimeout;
50    private final String name;
51    private final StripedReadWriteLockSync cacheLockProvider = new StripedReadWriteLockSync();
52   
 
53  0 toggle public AbstractBlockingCache(String name, CacheModule cacheModule, Integer blockingTimeout) {
54  0 super(cacheModule);
55  0 this.blockingTimeout = blockingTimeout;
56  0 this.name = name;
57    }
58   
 
59  0 toggle @Override
60    public final Object get(Object key) {
61  0 super.get(key);
62  0 ReadWriteLockSync lock = getLockForKey(key);
63  0 acquiredLockForKey(key, lock, LockType.READ);
64  0 Object element;
65  0 try {
66  0 element = this.getQuiet(key);
67    } finally {
68  0 lock.unlock(LockType.READ);
69    }
70  0 if (element == null) {
71  0 acquiredLockForKey(key, lock, LockType.WRITE);
72  0 element = this.getQuiet(key);
73  0 if (element != null) {
74  0 lock.unlock(LockType.WRITE);
75    }
76    }
77  0 return element;
78    }
79   
 
80  0 toggle @Override
81    public final boolean hasElement(Object key) {
82  0 return get(key) != null;
83    }
84   
 
85  0 toggle @Override
86    public final void put(Object key, Object value) {
87  0 put(key, value, -1);
88    }
89   
 
90  0 toggle @Override
91    public final void put(Object key, Object value, int timeToLiveInSeconds) {
92  0 ReadWriteLockSync lock = getLockForKey(key);
93  0 if (!lock.isHeldByCurrentThread(LockType.WRITE)) {
94  0 lock.lock(LockType.WRITE);
95    }
96  0 try {
97  0 if (value != null) {
98  0 putQuiet(key, value, timeToLiveInSeconds);
99    }
100    } finally {
101    //Release the write lock here. This will have been acquired in the get, where the element was null
102  0 lock.unlock(LockType.WRITE);
103    }
104  0 super.put(key, value, timeToLiveInSeconds);
105    }
106   
107    protected abstract void putQuiet(Object key, Object value, int timeToLiveInSeconds);
108   
 
109  0 toggle @Override
110    public final void unlock(Object key) {
111  0 ReadWriteLockSync lock = getLockForKey(key);
112  0 if (lock.isHeldByCurrentThread(LockType.WRITE)) {
113  0 lock.unlock(LockType.WRITE);
114    }
115    }
116   
 
117    toggle @Override
118    public int getBlockingTimeout() {
119    return blockingTimeout;
120    }
121   
 
122    toggle @Override
123    public String getName() {
124    return name;
125    }
126   
 
127  0 toggle private ReadWriteLockSync getLockForKey(final Object key) {
128  0 return cacheLockProvider.getSyncForKey(key);
129    }
130   
 
131  0 toggle private void acquiredLockForKey(final Object key, final ReadWriteLockSync lock, final LockType lockType) {
132  0 if (blockingTimeout > 0) {
133  0 try {
134  0 boolean acquired = lock.tryLock(lockType, blockingTimeout);
135  0 if (!acquired) {
136  0 StringBuilder message = new StringBuilder("Lock timeout. Waited more than ")
137    .append(blockingTimeout)
138    .append("ms to acquire lock for key ")
139    .append(key).append(" on blocking cache ").append(this.getName());
140  0 throw new MgnlLockTimeoutException(message.toString());
141    }
142    } catch (InterruptedException e) {
143  0 throw new MgnlLockTimeoutException("Got interrupted while trying to acquire lock for key " + key, e);
144    }
145    } else {
146  0 lock.lock(lockType);
147    }
148    }
149   
150    }