catalog-be/src/main/java/org/openecomp/sdc/be/plugins/CsarZipGenerator.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2023 Nordix Foundation. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.openecomp.sdc.be.plugins;
  21
  22 import fj.data.Either;
  23 import java.io.IOException;
  24 import java.util.zip.ZipOutputStream;
  25 import org.openecomp.sdc.be.model.Component;
  26 import org.openecomp.sdc.exception.ResponseFormat;
  27
  28 /**
  29  * Implementations of this interface shall generate a csar file.
  30  */
  31 public interface CsarZipGenerator {
  32
  33     /**
  34      * Generate the csar file.
  35      *
  36      * @param component the component the csar is based on
  37      * @return Map of name to contents for entries to be included in the csar
  38      */
  39     Either<ZipOutputStream, ResponseFormat> generateCsarZip(
  40         final Component component,
  41         boolean getFromCS,
  42         ZipOutputStream zip,
  43         boolean isInCertificationRequest,
  44         boolean isAsdPackage
  45     ) throws IOException;
  46
  47     String getModel();
  48 }