001/*
002 *  Copyright 2018 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.extraction.execution.pipeline.impl;
017
018import java.io.Closeable;
019
020import org.ametys.plugins.extraction.execution.pipeline.Pipeline;
021
022/**
023 * A serializer for a {@link Pipeline}.
024 * <br>Must be {@link #close() closed}.
025 */
026public interface PipelineSerializer extends Closeable
027{
028    /**
029     * Prepares this serializer.
030     * @throws Exception if an error occured
031     */
032    void prepare() throws Exception;
033    
034    /**
035     * Does the serialization.
036     * <br>{@link #prepare()} method must have been called before.
037     * <br>Then, the pipeline must be {@link #close() closed}.
038     * @throws Exception if an error occured
039     */
040    void serialize() throws Exception;
041}