SourceManager.java

/*
 * Copyright 2022 PPI AG (Hamburg, Germany)
 * This program is made available under the terms of the MIT License.
 */

package de.ppi.deepsampler.persistence.api;

import de.ppi.deepsampler.core.model.ExecutionInformation;
import de.ppi.deepsampler.persistence.PersistentSamplerContext;
import de.ppi.deepsampler.persistence.model.PersistentModel;

import java.util.Map;

/**
 * <p>
 * A SourceManager is responsible for interacting with the actual persistent source.
 * </p>
 *
 * When implementing you have to define two methods:
 * <ul>
 *     <li>save(...): Basically you have to write the provided data to your data source. There is no constraint on
 *     how you do it, but you should write it in a form so that you are able to load it correctly again.</li>
 *     <li>load(...): Load your data and transform your data to an implementation of {@link PersistentModel}</li>
 * </ul>
 */
public interface SourceManager {

    /**
     * Save the executionInformation collected on runtime to your data source.
     *
     * @param executionInformation     the executionInformation mapped by class
     * @param persistentSamplerContext context of the persistent sampler
     */
    void save(Map<Class<?>, ExecutionInformation> executionInformation, PersistentSamplerContext persistentSamplerContext);

    /**
     * Load the persistent data. You will also have to transform this (if not already happened by design) to an
     * implementation of {@link PersistentModel} and its subordinated interfaces.
     *
     * @return PersistentModel
     */
    PersistentModel load();
}