gerrit.onap Code Review - sdc.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019, 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
  21 package org.openecomp.sdc.vendorsoftwareproduct.services.impl.etsi;
  22
  23 import org.openecomp.core.utilities.file.FileContentHandler;
  24 import org.openecomp.sdc.be.datatypes.enums.ResourceTypeEnum;
  25 import org.openecomp.sdc.tosca.csar.Manifest;
  26 import java.io.IOException;
  27
  28
  29 public interface ETSIService {
  30
  31     /**
  32      * Checks package structure is CSAR with TOSCA-Metadata directory according to SOL004 v2.5.1
  33      * and contains mandatory Entries in Tosca.meta
  34      * @param handler contains csar artifacts
  35      * @return true if all condition matched, false otherwise
  36      * @throws IOException when TOSCA.meta file is invalid
  37      */
  38     boolean isSol004WithToscaMetaDirectory(FileContentHandler handler) throws IOException;
  39
  40     /**
  41      * Update file structure. Moves non mano files to Artifacts/Deployment/non mano key location
  42      * @param handler
  43      * @param manifest
  44      */
  45     void moveNonManoFileToArtifactFolder(FileContentHandler handler, Manifest manifest);
  46
  47     /**
  48      * Retrieves the manifest file from the CSAR
  49      * @param handler contains csar artifacts
  50      * @throws IOException when TOSCA.meta file or manifest file is invalid
  51      */
  52     Manifest getManifest(FileContentHandler handler) throws IOException;
  53
  54     /**
  55      * Determmines the type of resource that the CSAR represents
  56      * @param handler contains csar artifacts
  57      * @throws IOException when TOSCA.meta file or manifest file is invalid
  58      */
  59     ResourceTypeEnum getResourceType(FileContentHandler handler) throws IOException;
  60
  61     /**
  62      * Determmines the type of resource that the CSAR represents
  63      * @param manifest contains manifest content
  64      * @throws IOException when TOSCA.meta file or manifest file is invalid
  65      */
  66     ResourceTypeEnum getResourceType(Manifest manifest) throws IOException;
  67 }