co.verisoft.fw.store.StoreManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-api Show documentation
VeriSoft framework for testing web and mobile applications. junit 5 Module
The newest version!
/*
 * (C) Copyright 2023 VeriSoft (http://www.verisoft.co)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 co.verisoft.fw.store;

import lombok.Synchronized;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;

import java.util.HashMap;
import java.util.Map;

/**
 * Global thread safe storage for objects. It is implemented as a singletone.

 * Example:

 * The following example is taken from the Store unit test, and provides a basic use of the store.
 * This example uses GLOBAL store, however similar code can be applied to LOCAL_THREAD store. 

 *  * {@code
 *         String name = "Nir";
 *         StoreManager.getStore(StoreType.GLOBAL).putValueInStore("NIR", name);
 *         String receivedName = StoreManager.getStore(StoreType.GLOBAL).getValueFromStore("NIR");
 *         Assertions.assertEquals(name, receivedName, "Should have retrieved from store");
 *  }
 * 
 *
 * @author Nir Gallner
 * @see Store
 * @see StoreImp
 * @see StoreType
 * @since 0.0.2 (Jan 2022)
 */
@ToString
@Slf4j
public class StoreManager {

    private static final Map storeMap = new HashMap<>();

    private StoreManager() {
    }


    /**
     * Retrieve store from the store object, according to store type selected.
     * If there is no store, which previously registered, it will create a new store and retrieve it
     *
     * @param storeType Type of store to retrieve (local by thread / global to all threads)
     * @return Store object, according to type selected
     */
    @Synchronized
    public static Store getStore(StoreType storeType) {
        Long threadId = (storeType == StoreType.LOCAL_THREAD) ?
                Thread.currentThread().getId() : 0;

        // Show only global access to store
        if (threadId == 0){
            log.debug("Get store of thread " + threadId + " (0 means global)");
        }
        else
            log.trace("Get store of thread " + threadId + " (0 means global)");


        // If store not exist, create a store
        if (storeMap.get(threadId) == null)
            storeMap.put(threadId, new StoreImp());

        return storeMap.get(threadId);
    }

    /**
     * Retrieve store from the store object, according to name selected.
     * If there is no store, which previously registered, it will create a new store and retrieve it
     *
     * @param storeName Name of store to retrieve (The key will be the name + "Store" for example: name=example so the name=exampleStore)
     * @return Store object, according to name selected
     * @author Gili Eliach
     */
    @Synchronized
    public static Store getStore(String storeName) {
        String newStoreName=storeName+"Store";
        // If store not exist, create a store
        if (storeMap.get(newStoreName) == null)
            storeMap.put(newStoreName, new StoreImp());

        return storeMap.get(newStoreName);
    }

    /**
     * Deletes a Store object from the map, or does nothing if there was no object to begin with
     *
     * @param storeType Type of store to remove (local thread / global)
     */
    @Synchronized
    public static void removeStore(StoreType storeType) {
        Long threadId = (storeType == StoreType.LOCAL_THREAD) ?
                Thread.currentThread().getId() : 0;
        log.debug("Remove store of thread (0 means global) " + threadId);
        storeMap.remove(threadId);
    }

    /**
     * Deletes a Store object from the map, or does nothing if there was no object to begin with
     *
     * @param storeName name of store to remove
     * @author Gili Eliach
     */
    @Synchronized
    public static void removeStore(String storeName) {
        log.debug("Remove store " + storeName);
        storeMap.remove(storeName+"Store");
    }
}