dev.galasa.framework.internal.dss.FpfDynamicStatusStore Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dev.galasa.framework Show documentation
A Galasa project
There is a newer version: 0.37.0
/*
 * Copyright contributors to the Galasa project
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package dev.galasa.framework.internal.dss;

import java.io.IOException;
import java.net.URI;
import java.util.Map;
import java.util.Set;
import java.util.UUID;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Null;

import dev.galasa.framework.spi.DynamicStatusStoreException;
import dev.galasa.framework.spi.DynamicStatusStoreMatchException;
import dev.galasa.framework.spi.FrameworkPropertyFile;
import dev.galasa.framework.spi.FrameworkPropertyFileException;
import dev.galasa.framework.spi.IDssAction;
import dev.galasa.framework.spi.IDynamicStatusStore;
import dev.galasa.framework.spi.IDynamicStatusStoreWatcher;
import dev.galasa.framework.spi.IFrameworkPropertyFileWatcher;

/**
 * 
 * This class is used when the FPF class is being operated as the Key-Value
 * store for the Dynamic Status Store.
 * 
 * 
 *  
 */
public class FpfDynamicStatusStore implements IDynamicStatusStore {
    private FrameworkPropertyFile fpf;

    public FpfDynamicStatusStore(URI file) throws DynamicStatusStoreException {
        try {
            fpf = new FrameworkPropertyFile(file);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Failed to create Framework property file", e);
        }
    }

    /**
     * 
     * This method puts a key/value pair in the DSS.
     * 
     * 
     * @param key
     * @param value
     * @throws DynamicStatusStoreException
     */
    @Override
    public void put(@NotNull String key, @NotNull String value) throws DynamicStatusStoreException {
        try {
            fpf.set(key, value);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to put key/value pair", e);
        }

    }

    /**
     * 
     * This method puts multiple key/value pairs in the DSS.
     * 
     * 
     * @param keyValues
     * @throws DynamicStatusStoreException
     */
    @Override
    public void put(@NotNull Map keyValues) throws DynamicStatusStoreException {
        try {
            fpf.set(keyValues);
        } catch (FrameworkPropertyFileException | IOException e) {
            throw new DynamicStatusStoreException("Unable to put map of key/value pairs", e);
        }

    }

    /**
     * 
     * This method swaps an old value with a new value for a given key in the DSS.
     * 
     * 
     * @param key
     * @param oldValue
     * @param newValue
     * @throws DynamicStatusStoreException
     */
    @Override
    public boolean putSwap(@NotNull String key, String oldValue, @NotNull String newValue)
            throws DynamicStatusStoreException {
        try {
            return fpf.setAtomic(key, oldValue, newValue);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to swap old value for new value with given key", e);
        }
    }

    /**
     * 
     * This method swaps an old value with a new value for a given key and puts
     * multiple key/value pairs in the DSS.
     * 
     * 
     * @param key
     * @param oldValue
     * @param newValue
     * @param others
     * @throws DynamicStatusStoreException
     */
    @Override
    public boolean putSwap(@NotNull String key, String oldValue, @NotNull String newValue,
            @NotNull Map others) throws DynamicStatusStoreException {
        try {
            return fpf.setAtomic(key, oldValue, newValue, others);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException(
                    "Unable to swap old value for new value and put map of key/value pairs with given key", e);
        }
    }

    /**
     * 
     * This method gets a value from a given key in the DSS.
     * 
     * 
     * @param key
     * @throws DynamicStatusStoreException
     */
    @Override
    public @Null String get(@NotNull String key) throws DynamicStatusStoreException {
        return fpf.get(key);
    }

    /**
     * 
     * This method gets all key/value pairs with a given key prefix from the DSS.
     * 
     * 
     * @param keyPrefix
     * @throws DynamicStatusStoreException
     */
    @Override
    public @NotNull Map getPrefix(@NotNull String keyPrefix) throws DynamicStatusStoreException {
        try {
            return fpf.getPrefix(keyPrefix);
        } catch (Exception e) {
            throw new DynamicStatusStoreException("Unable to get map of key/value pairs with given key prefix", e);
        }
    }

    /**
     * 
     * This method deleted a key/value pair with a given key from the DSS.
     * 
     * 
     * @param key
     * @throws DynamicStatusStoreException
     */
    @Override
    public void delete(@NotNull String key) throws DynamicStatusStoreException {
        try {
            fpf.delete(key);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to delete key/value pair with given key", e);
        }
    }

    /**
     * 
     * This method deletes multiple key/value pairs with the given keys from the
     * DSS.
     * 
     * 
     * @param keys
     * @throws DynamicStatusStoreException
     */
    @Override
    public void delete(@NotNull Set keys) throws DynamicStatusStoreException {
        try {
            fpf.delete(keys);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to delete key/value pairs with given keys", e);
        }
    }

    /**
     * 
     * This method deletes multiple key/value pairs with a given key prefix from the
     * DSS.
     * 
     * 
     * @param keyPrefix
     * @throws DynamicStatusStoreException
     */
    @Override
    public void deletePrefix(@NotNull String keyPrefix) throws DynamicStatusStoreException {
        try {
            fpf.deletePrefix(keyPrefix);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to delete key/value pairs with given key prefix", e);
        }
    }
    
    @Override
    public void performActions(IDssAction... actions) throws DynamicStatusStoreException, DynamicStatusStoreMatchException {
        fpf.performActions(actions);
    }

    @Override
    public UUID watch(IDynamicStatusStoreWatcher watcher, String key) throws DynamicStatusStoreException {
        try {
            return fpf.watch(new PassthroughWatcher(watcher), key);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to set a new watch on key '" + key + "'", e);
        }
    }

    @Override
    public UUID watchPrefix(IDynamicStatusStoreWatcher watcher, String keyPrefix) throws DynamicStatusStoreException {
        try {
            return fpf.watchPrefix(new PassthroughWatcher(watcher), keyPrefix);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to set a new watch on keyprefix '" + keyPrefix + "'", e);
        }
    }

    @Override
    public void unwatch(UUID watchId) throws DynamicStatusStoreException {
        try {
            fpf.unwatch(watchId);
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Unable to unwatch", e);
        }
    }

    private static class PassthroughWatcher implements IFrameworkPropertyFileWatcher {

        private final IDynamicStatusStoreWatcher watcher;

        private PassthroughWatcher(IDynamicStatusStoreWatcher watcher) {
            this.watcher = watcher;
        }

        @Override
        public void propertyModified(String key, Event event, String oldValue, String newValue) {
            watcher.propertyModified(key, IDynamicStatusStoreWatcher.Event.valueOf(event.toString()), oldValue,
                    newValue);
        }

    }

    @Override
    public void shutdown() throws DynamicStatusStoreException {
        try {
            this.fpf.shutdown();
        } catch (FrameworkPropertyFileException e) {
            throw new DynamicStatusStoreException("Problem shutting down the DSS File", e);
        }
    }

}