org.wso2.carbon.caching.impl.CarbonCacheManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javax.cache.wso2 Show documentation
OSGi Bundle for JCache API
The newest version!
/*
*  Copyright (c) 2005-2011, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
*
*  WSO2 Inc. licenses this file to you under the Apache License,
*  Version 2.0 (the "License"); you may not use this file except
*  in compliance with the License.
*  You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.wso2.carbon.caching.impl;

import org.wso2.carbon.context.CarbonContext;
import org.wso2.carbon.base.ServerConfiguration;
import org.wso2.carbon.utils.multitenancy.MultitenantConstants;

import javax.cache.Cache;
import javax.cache.CacheBuilder;
import javax.cache.CacheException;
import javax.cache.CacheManager;
import javax.cache.OptionalFeature;
import javax.cache.Status;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import static org.wso2.carbon.caching.impl.CachingConstants.ILLEGAL_STATE_EXCEPTION_MESSAGE;

/**
 * TODO: class description
 */
public class CarbonCacheManager implements CacheManager {
    private Map> caches = new ConcurrentHashMap>();
    private volatile Status status;
    private String name;

    private String ownerTenantDomain;
    private int ownerTenantId;
    private CacheManagerFactoryImpl cacheManagerFactory;

    private long lastAccessed = -1;

    public CarbonCacheManager(String name, CacheManagerFactoryImpl cacheManagerFactory) {
        this.cacheManagerFactory = cacheManagerFactory;
        CarbonContext carbonContext = CarbonContext.getThreadLocalCarbonContext();
        if (carbonContext == null) {
            throw new IllegalStateException("CarbonContext cannot be null");
        }
        ownerTenantDomain = carbonContext.getTenantDomain();
        if (ownerTenantDomain == null) {
            throw new IllegalStateException("Tenant domain cannot be " + ownerTenantDomain);
        }
        ownerTenantId = carbonContext.getTenantId();
        if (ownerTenantId == MultitenantConstants.INVALID_TENANT_ID) {
            throw new IllegalStateException("Tenant ID cannot be " + ownerTenantId);
        }
        this.name = name;
        touch();
        status = Status.STARTED;
    }

    public int getOwnerTenantId() {
        return ownerTenantId;
    }

    @Override
    public String getName() {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        return this.name;
    }

    @Override
    public Status getStatus() {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        return status;
    }

    @Override
    public  CacheBuilder createCacheBuilder(String cacheName) {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();

        if (cacheName == null) {
            throw new NullPointerException("A cache name must not be null.");
        }

        cacheName = getCacheName(cacheName);
        if (caches.get(cacheName) != null) {
            throw new CacheException("Cache " + cacheName + " already exists");
        }
        
        Pattern searchPattern = Pattern.compile("\\S+");
        Matcher matcher = searchPattern.matcher(cacheName);
        if (!matcher.find()) {
            throw new IllegalArgumentException("A cache name must contain one or more non-whitespace characters");
        }

        return new CacheBuilderImpl(cacheName, this);
    }

    @Override
    @SuppressWarnings("unchecked")
    public  Cache getCache(String cacheName) {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        if (status != Status.STARTED) {
            throw new IllegalStateException();
        }
        touch();
        cacheName = getCacheName(cacheName);
        Cache cache = (Cache) caches.get(cacheName);
        if (cache == null) {
            synchronized (cacheName.intern()) {
                if ((cache = (Cache) caches.get(cacheName)) == null) {
                    caches.put(cacheName, cache = new CacheImpl(cacheName, this));
                }
            }
        }
        return cache;
    }

    void switchToDistributedMode(){
        for (Cache cache : caches.values()) {
            ((CacheImpl) cache).switchToDistributedMode();
        }
    }

    @SuppressWarnings("unchecked")
    final  Cache getExistingCache(String cacheName) {
        touch();
        cacheName = getCacheName(cacheName);
        return (Cache) caches.get(cacheName);
    }

    @Override
    public Iterable> getCaches() {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        if (status != Status.STARTED) {
            throw new IllegalStateException();
        }
        touch();
        HashSet> set = new HashSet>();
        for (Cache cache : caches.values()) {
            set.add(cache);
        }
        return Collections.unmodifiableSet(set);
    }

    @Override
    public boolean removeCache(String cacheName) {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        if (status != Status.STARTED) {
            throw new IllegalStateException();
        }
        if (cacheName == null) {
            throw new NullPointerException("Cache name cannot be null");
        }
        cacheName = getCacheName(cacheName);
        CacheImpl oldCache;
        oldCache = (CacheImpl) caches.remove(cacheName);
        if (oldCache != null) {
            oldCache.stop();
        }
        cacheManagerFactory.removeCacheFromMonitoring(oldCache);
        DistributedMapProvider distributedMapProvider = DataHolder.getInstance().getDistributedMapProvider();
        if (distributedMapProvider != null) {
            distributedMapProvider.removeMap(Util.getDistributedMapNameOfCache(cacheName,ownerTenantDomain,
                    this.getName()));
        }
        if (caches.isEmpty() && isIdle()) {
            cacheManagerFactory.removeCacheManager(this, ownerTenantDomain);
        }
        touch();
        return oldCache != null;
    }

    /**
     * Removes all local caches and returns whether there are no more caches managed by this CacheManager.
     *
     * @return true if there are no caches managed by this CacheManager and false otherwise
     */
    boolean removeLocalCaches() {
        for (Cache cache : caches.values()) {
            boolean isLocalCache = cache.getName().startsWith(CachingConstants.LOCAL_CACHE_PREFIX);
            if (isLocalCache) {
                removeCache(cache.getName());
            }
        }
        return this.caches.isEmpty();
    }

    @Override
    public javax.transaction.UserTransaction getUserTransaction() {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        touch();
        return null;  //To change body of implemented methods use File | Settings | File Templates.
    }

    @Override
    public boolean isSupported(OptionalFeature optionalFeature) {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        return false;  //To change body of implemented methods use File | Settings | File Templates.
    }

    @Override
    public void shutdown() {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        for (Cache cache : caches.values()) {
            try {
                cache.stop();
            } catch (Exception ignored) {
            }
        }
        caches.clear();
        this.status = Status.STOPPED;
    }

    @Override
    public  T unwrap(Class cls) {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        if (cls.isAssignableFrom(this.getClass())) {
            return cls.cast(this);
        }

        throw new IllegalArgumentException("Unwrapping to " + cls +
                                           " is not a supported by this implementation");
    }

    void addCache(CacheImpl cache) {
        Util.checkAccess(ownerTenantDomain, ownerTenantId);
        checkStatusStarted();
        String cacheName = cache.getName();
        cacheName = getCacheName(cacheName);
        caches.put(cacheName, cache);
        touch();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        CarbonCacheManager that = (CarbonCacheManager) o;

        if (ownerTenantId != that.ownerTenantId) return false;
        if (name != null ? !name.equals(that.name) : that.name != null) return false;
        if (ownerTenantDomain != null ? !ownerTenantDomain.equals(that.ownerTenantDomain) : that.ownerTenantDomain != null)
            return false;

        return true;
    }

    @Override
    public int hashCode() {
        int result = name != null ? name.hashCode() : 0;
        result = 31 * result + (ownerTenantDomain != null ? ownerTenantDomain.hashCode() : 0);
        result = 31 * result + ownerTenantId;
        return result;
    }

    private void checkStatusStarted() {
        if (!status.equals(Status.STARTED)) {
            throw new IllegalStateException(ILLEGAL_STATE_EXCEPTION_MESSAGE);
        }
    }

    private void touch(){
        lastAccessed = System.currentTimeMillis();
    }

    private boolean isIdle() {
        long timeDiff = System.currentTimeMillis() - lastAccessed;
        return caches.isEmpty() && (timeDiff >= CachingConstants.MAX_CACHE_IDLE_TIME_MILLIS);
    }

    private String getCacheName(String cacheName) {

        if (Boolean.parseBoolean(ServerConfiguration.getInstance().getFirstProperty(CachingConstants.FORCE_LOCAL_CACHE))) {
            if (!cacheName.startsWith(CachingConstants.LOCAL_CACHE_PREFIX)) {
                return CachingConstants.LOCAL_CACHE_PREFIX + cacheName;
            }
        }
        return cacheName;
    }
}