org.flowable.ldap.LDAPGroupCache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flowable-ldap Show documentation
There is a newer version: 7.1.0
/* Licensed 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.flowable.ldap;

import java.util.Date;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Supplier;

import org.flowable.common.engine.impl.runtime.ClockReader;
import org.flowable.idm.api.Group;

/**
 * Simple cache for groups a user belongs to, which avoid hitting the LDAP system too much. Groups are fetched internally by the engine for example when doing queries, eg when fetching tasks for a
 * candidateUser. Configured through the {@link LDAPConfiguration}.
 * 
 * Cached entries have an expiration time. For example when set to one hour, changes to the ldap system around the groups of a user will be visible after that hour.
 * 
 * Experimental: can have a listener for cache events, and instance of {@link LDAPGroupCacheListener}.
 * 
 * @author Joram Barrez
 */
public class LDAPGroupCache {

    private final Supplier clockReader;
    protected Map groupCache;
    protected long expirationTime;

    protected LDAPGroupCacheListener ldapCacheListener;

    public LDAPGroupCache(final int cacheSize, final long expirationTime, final ClockReader clockReader) {
        this(cacheSize, expirationTime, () -> clockReader);
    }

    public LDAPGroupCache(final int cacheSize, final long expirationTime, final Supplier clockReader) {
        this.clockReader = clockReader;

        // From
        // http://stackoverflow.com/questions/224868/easy-simple-to-use-lru-cache-in-java
        this.groupCache = new LinkedHashMap(cacheSize + 1, 0.75f, true) {

            private static final long serialVersionUID = 5207574193173514579L;

            @Override
            protected boolean removeEldestEntry(Map.Entry eldest) {
                boolean removeEldest = size() > cacheSize;

                if (removeEldest && ldapCacheListener != null) {
                    ldapCacheListener.cacheEviction(eldest.getKey());
                }

                return removeEldest;
            }

        };
        this.expirationTime = expirationTime;
    }

    public void add(String userId, List groups) {
        this.groupCache.put(userId, new LDAPGroupCacheEntry(clockReader.get().getCurrentTime(), groups));
    }

    public List get(String userId) {
        LDAPGroupCacheEntry cacheEntry = groupCache.get(userId);
        if (cacheEntry != null) {
            if ((clockReader.get().getCurrentTime().getTime() - cacheEntry.getTimestamp().getTime()) < expirationTime) {

                if (ldapCacheListener != null) {
                    ldapCacheListener.cacheHit(userId);
                }

                return cacheEntry.getGroups();

            } else {

                this.groupCache.remove(userId);

                if (ldapCacheListener != null) {
                    ldapCacheListener.cacheExpired(userId);
                    ldapCacheListener.cacheEviction(userId);
                }

            }
        }

        if (ldapCacheListener != null) {
            ldapCacheListener.cacheMiss(userId);
        }

        return null;
    }

    public void clear() {
        groupCache.clear();
    }

    public Map getGroupCache() {
        return groupCache;
    }

    public void setGroupCache(Map groupCache) {
        this.groupCache = groupCache;
    }

    public long getExpirationTime() {
        return expirationTime;
    }

    public void setExpirationTime(long expirationTime) {
        this.expirationTime = expirationTime;
    }

    public LDAPGroupCacheListener getLdapCacheListener() {
        return ldapCacheListener;
    }

    public void setLdapCacheListener(LDAPGroupCacheListener ldapCacheListener) {
        this.ldapCacheListener = ldapCacheListener;
    }

    // Helper classes ////////////////////////////////////

    static class LDAPGroupCacheEntry {

        protected Date timestamp;
        protected List groups;

        public LDAPGroupCacheEntry() {

        }

        public LDAPGroupCacheEntry(Date timestamp, List groups) {
            this.timestamp = timestamp;
            this.groups = groups;
        }

        public Date getTimestamp() {
            return timestamp;
        }

        public void setTimestamp(Date timestamp) {
            this.timestamp = timestamp;
        }

        public List getGroups() {
            return groups;
        }

        public void setGroups(List groups) {
            this.groups = groups;
        }

    }

    // Cache listeners. Currently not yet exposed (only programmatically for the
    // moment)

    // Experimental stuff!

    public static interface LDAPGroupCacheListener {

        void cacheHit(String userId);

        void cacheMiss(String userId);

        void cacheEviction(String userId);

        void cacheExpired(String userId);

    }

}