catalog-be-plugins/etsi-nfv-nsd-csar-plugin/src/main/java/org/openecomp/sdc/be/plugins/etsi/nfv/nsd/generator/VnfDescriptorGenerator.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Nordix Foundation
   4  *  ================================================================================
   5  *  Licensed under the Apache License, Version 2.0 (the "License");
   6  *  you may not use this file except in compliance with the License.
   7  *  You may obtain a copy of the License at
   8  *
   9  *        http://www.apache.org/licenses/LICENSE-2.0
  10  *  Unless required by applicable law or agreed to in writing, software
  11  *  distributed under the License is distributed on an "AS IS" BASIS,
  12  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *  See the License for the specific language governing permissions and
  14  *  limitations under the License.
  15  *
  16  *  SPDX-License-Identifier: Apache-2.0
  17  *  ============LICENSE_END=========================================================
  18  */
  19
  20 package org.openecomp.sdc.be.plugins.etsi.nfv.nsd.generator;
  21
  22 import java.util.Optional;
  23 import org.openecomp.sdc.be.model.ArtifactDefinition;
  24 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.exception.VnfDescriptorException;
  25 import org.openecomp.sdc.be.plugins.etsi.nfv.nsd.model.VnfDescriptor;
  26
  27 /**
  28  * Generator of a VNF Descriptor from the ONBOARDED_PACKAGE
  29  */
  30 public interface VnfDescriptorGenerator {
  31
  32     /**
  33      * Generates the a VNF Descriptor based on the ONBOARDED_PACKAGE artifact.
  34      *
  35      * @param name the name of the VNF package
  36      * @param onboardedPackageArtifact the onboarded package for the VNF
  37      * @return a representation of the VNF package
  38      * @throws VnfDescriptorException when a problem happens during the generation
  39      */
  40     Optional<VnfDescriptor> generate(final String name, final ArtifactDefinition onboardedPackageArtifact)
  41         throws VnfDescriptorException;
  42
  43 }