001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.plugins.contentio.archive;
017
018import java.util.stream.Stream;
019
020/**
021 * The manifest reader/writer, which is responsible to write into the Manifest file the exposed {@link PartialImport}s, 
022 * and to read from a Manifest file those exposed {@link PartialImport}s.
023 */
024public interface ManifestReaderWriter
025{
026    /**
027     * Gets the manifest content to write related to the exported data by the {@link Archiver}.
028     * @return the manifest content to write
029     */
030    Object getData();
031    
032    /**
033     * Reads the available partial imports from the given raw JSON data
034     * @param data The raw JSON data
035     * @return the available partial imports
036     */
037    Stream<PartialImport> toPartialImports(Object data);
038}