adapters/etsi-sol003-adapter/etsi-sol003-package-management/etsi-sol003-package-management-adapter/src/main/java/org/onap/so/adapters/etsisol003adapter/pkgm/extclients/etsicatalog/EtsiCatalogPackageManagementServiceProvider.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2020 Ericsson. All rights reserved.
   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  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.onap.so.adapters.etsisol003adapter.pkgm.extclients.etsicatalog;
  21
  22 import java.util.Optional;
  23 import org.onap.so.adapters.etsisol003adapter.pkgm.model.InlineResponse2001;
  24
  25 /**
  26  * @author Waqas Ikram (waqas.ikram@est.tech)
  27  *
  28  */
  29 public interface EtsiCatalogPackageManagementServiceProvider {
  30
  31     /**
  32      * GET Package Content, from VNF Package.
  33      *
  34      * @param vnfPkgId The ID of the VNF Package from which the "package_content" will be retrieved.
  35      * @return The Package Content of a VNF Package ("vnfPkgId").
  36      */
  37     Optional<byte[]> getVnfPackageContent(final String vnfPkgId);
  38
  39     /**
  40      * GET VNF packages information from ETSI Catalog. Will return zero or more VNF package representations.
  41      *
  42      * @return An Array of all VNF packages retrieved from the ETSI Catalog.
  43      */
  44     Optional<InlineResponse2001[]> getVnfPackages();
  45
  46     /**
  47      * GET specific VNF package information from ETSI Catalog.
  48      *
  49      * @param vnfPkgId The ID of the VNF Package that you want to query.
  50      * @return The VNF package retrieved from the ETSI Catalog
  51      */
  52     Optional<InlineResponse2001> getVnfPackage(final String vnfPkgId);
  53
  54     /**
  55      * GET specific VNF package VNFD from ETSI Catalog.
  56      *
  57      * @param vnfPkgId The ID of the VNF Package that you want to query.
  58      * @return The VNF package retrieved from the ETSI Catalog
  59      */
  60     Optional<byte[]> getVnfPackageVnfd(final String vnfPkgId);
  61
  62     /**
  63      * GET Package Artifact, from VNF Package.
  64      *
  65      * @param vnfPkgId The ID of the VNF Package from which the artifact will be retrieved.
  66      * @param artifactPath Sequence of one or more path segments representing the path of the artifact within the VNF
  67      *        Package, e.g., foo/bar/run.sh
  68      * @return The Package Artifact of a VNF Package ("vnfPkgId", "artifactPath").
  69      */
  70     Optional<byte[]> getVnfPackageArtifact(final String vnfPkgId, final String artifactPath);
  71
  72 }