winery/org.eclipse.winery.repository/src/main/java/org/eclipse/winery/repository/backend/IRepositoryAdministration.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012-2013 University of Stuttgart.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * and the Apache License 2.0 which both accompany this distribution,
   6  * and are available at http://www.eclipse.org/legal/epl-v10.html
   7  * and http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Contributors:
  10  *     Oliver Kopp - initial API and implementation
  11  *******************************************************************************/
  12 package org.eclipse.winery.repository.backend;
  13
  14 import java.io.IOException;
  15 import java.io.InputStream;
  16 import java.io.OutputStream;
  17
  18 /**
  19  * Interface for low-level repository administration
  20  */
  21 public interface IRepositoryAdministration {
  22
  23         /**
  24          * Dumps the content of the repository to the given output stream
  25          *
  26          * @param out stream to use to dump the data to. Currently, a ZIP output
  27          *            stream is returned.
  28          * @throws IOException
  29          */
  30         void doDump(OutputStream out) throws IOException;
  31
  32         /**
  33          * Removes all data
  34          */
  35         void doClear();
  36
  37         /**
  38          * Imports the content of the given stream into the repsotiry.
  39          *
  40          * @param in the stream to use. Currently, only ZIP input is supported.
  41          */
  42         void doImport(InputStream in);
  43 }