org.ff4j.store.FeatureStoreJCache Maven / Gradle / Ivy
package org.ff4j.store;
/*
* #%L
* ff4j-store-redis
* %%
* Copyright (C) 2013 - 2014 Ff4J
* %%
* 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.
* #L%
*/
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.ff4j.cache.FF4jJCacheManager;
import org.ff4j.core.Feature;
import org.ff4j.core.FeatureStore;
import org.ff4j.exception.FeatureAlreadyExistException;
import org.ff4j.exception.FeatureNotFoundException;
import org.ff4j.exception.GroupNotFoundException;
import org.ff4j.utils.Util;
/**
* Generic {@link FeatureStore} to persist properties in a JCache (JSR107) compliant storage.
*
* @author Cedrick LUNVEN
*/
public class FeatureStoreJCache extends AbstractFeatureStore {
/** Cache Manager. */
private FF4jJCacheManager cacheManager;
/**
* Initialization with cache manager.
*
* @param cacheManager
*/
public FeatureStoreJCache(FF4jJCacheManager cacheManager) {
this.cacheManager = cacheManager;
}
/**
* Default Constructor.
*/
public FeatureStoreJCache(String cachingProviderClassName) {
this(new FF4jJCacheManager(cachingProviderClassName));
}
/** {@inheritDoc} */
@Override
public boolean exist(String uid) {
Util.assertParamHasLength(uid, "Feature identifier");
return getCacheManager().getFeature(uid) != null;
}
/** {@inheritDoc} */
@Override
public Feature read(String uid) {
if (!exist(uid)) {
throw new FeatureNotFoundException(uid);
}
return getCacheManager().getFeature(uid);
}
/** {@inheritDoc} */
@Override
public void update(Feature fp) {
if (fp == null) {
throw new IllegalArgumentException("Feature cannot be null");
}
if (!exist(fp.getUid())) {
throw new FeatureNotFoundException(fp.getUid());
}
getCacheManager().putFeature(fp);
}
/** {@inheritDoc} */
@Override
public void enable(String uid) {
// Read from redis, feature not found if no present
Feature f = read(uid);
// Update within Object
f.enable();
// Serialization and update key, update TTL
update(f);
}
/** {@inheritDoc} */
@Override
public void disable(String uid) {
// Read from redis, feature not found if no present
Feature f = read(uid);
// Update within Object
f.disable();
// Serialization and update key, update TTL
update(f);
}
/** {@inheritDoc} */
@Override
public void create(Feature fp) {
if (fp == null) {
throw new IllegalArgumentException("Feature cannot be null nor empty");
}
if (exist(fp.getUid())) {
throw new FeatureAlreadyExistException(fp.getUid());
}
getCacheManager().putFeature(fp);
}
/** {@inheritDoc} */
@Override
public Map readAll() {
Map myMap = new HashMap<>();
getCacheManager().getFeaturesCache().forEach(e->myMap.put(e.getKey(), e.getValue()));
return myMap;
}
/** {@inheritDoc} */
@Override
public void delete(String fpId) {
if (!exist(fpId)) {
throw new FeatureNotFoundException(fpId);
}
getCacheManager().evictFeature(fpId);
}
/** {@inheritDoc} */
@Override
public void grantRoleOnFeature(String flipId, String roleName) {
Util.assertParamHasLength(roleName, "roleName (#2)");
// retrieve
Feature f = read(flipId);
// modify
f.getPermissions().add(roleName);
// persist modification
update(f);
}
/** {@inheritDoc} */
@Override
public void removeRoleFromFeature(String flipId, String roleName) {
Util.assertParamHasLength(roleName, "roleName (#2)");
// retrieve
Feature f = read(flipId);
f.getPermissions().remove(roleName);
// persist modification
update(f);
}
/** {@inheritDoc} */
@Override
public Map readGroup(String groupName) {
Util.assertParamHasLength(groupName, "groupName");
Map < String, Feature > features = readAll();
Map < String, Feature > group = new HashMap<>();
for (Map.Entry uid : features.entrySet()) {
if (groupName.equals(uid.getValue().getGroup())) {
group.put(uid.getKey(), uid.getValue());
}
}
if (group.isEmpty()) {
throw new GroupNotFoundException(groupName);
}
return group;
}
/** {@inheritDoc} */
@Override
public boolean existGroup(String groupName) {
Util.assertParamHasLength(groupName, "groupName");
Map < String, Feature > features = readAll();
Map < String, Feature > group = new HashMap<>();
for (Map.Entry uid : features.entrySet()) {
if (groupName.equals(uid.getValue().getGroup())) {
group.put(uid.getKey(), uid.getValue());
}
}
return !group.isEmpty();
}
/** {@inheritDoc} */
@Override
public void enableGroup(String groupName) {
Map < String, Feature > features = readGroup(groupName);
for (Map.Entry uid : features.entrySet()) {
uid.getValue().enable();
update(uid.getValue());
}
}
/** {@inheritDoc} */
@Override
public void disableGroup(String groupName) {
Map < String, Feature > features = readGroup(groupName);
for (Map.Entry uid : features.entrySet()) {
uid.getValue().disable();
update(uid.getValue());
}
}
/** {@inheritDoc} */
@Override
public void addToGroup(String featureId, String groupName) {
Util.assertParamHasLength(groupName, "groupName (#2)");
// retrieve
Feature f = read(featureId);
f.setGroup(groupName);
// persist modification
update(f);
}
/** {@inheritDoc} */
@Override
public void removeFromGroup(String featureId, String groupName) {
Util.assertParamHasLength(groupName, "groupName (#2)");
if (!existGroup(groupName)) {
throw new GroupNotFoundException(groupName);
}
// retrieve
Feature f = read(featureId);
f.setGroup(null);
// persist modification
update(f);
}
/** {@inheritDoc} */
@Override
public Set readAllGroups() {
Map < String, Feature > features = readAll();
Set < String > groups = new HashSet<>();
for (Map.Entry uid : features.entrySet()) {
groups.add(uid.getValue().getGroup());
}
groups.remove(null);
return groups;
}
/** {@inheritDoc} */
@Override
public void clear() {
getCacheManager().getFeaturesCache().removeAll();
}
/**
* Getter accessor for attribute 'cacheManager'.
*
* @return
* current value of 'cacheManager'
*/
public FF4jJCacheManager getCacheManager() {
return cacheManager;
}
/**
* Setter accessor for attribute 'cacheManager'.
* @param cacheManager
* new value for 'cacheManager '
*/
public void setCacheManager(FF4jJCacheManager cacheManager) {
this.cacheManager = cacheManager;
}
}