gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 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  *
  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
  21 package org.onap.so.adapters.vnfmadapter.extclients.etsicatalog;
  22
  23 import java.util.Optional;
  24 import org.onap.so.adapters.vnfmadapter.extclients.etsicatalog.model.PkgmSubscription;
  25 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.packagemanagement.model.InlineResponse2001;
  26
  27 /**
  28  * Provides methods for invoking REST calls to the ETSI Catalog Manager.
  29  *
  30  * @author gareth.roper@est.tech
  31  */
  32 public interface EtsiCatalogServiceProvider {
  33
  34     /**
  35      * GET Package Content, from VNF Package.
  36      *
  37      * @param vnfPkgId The ID of the VNF Package from which the "package_content" will be retrieved.
  38      * @return The Package Content of a VNF Package ("vnfPkgId").
  39      */
  40     Optional<byte[]> getVnfPackageContent(final String vnfPkgId);
  41
  42     /**
  43      * GET VNF packages information from ETSI Catalog. Will return zero or more VNF package representations.
  44      *
  45      * @return An Array of all VNF packages retrieved from the ETSI Catalog.
  46      */
  47     Optional<InlineResponse2001[]> getVnfPackages();
  48
  49     /**
  50      * GET specific VNF package information from ETSI Catalog.
  51      *
  52      * @param vnfPkgId The ID of the VNF Package that you want to query.
  53      * @return The VNF package retrieved from the ETSI Catalog
  54      */
  55     Optional<InlineResponse2001> getVnfPackage(final String vnfPkgId);
  56
  57     /**
  58      * GET specific VNF package VNFD from ETSI Catalog.
  59      *
  60      * @param vnfPkgId The ID of the VNF Package that you want to query.
  61      * @return The VNF package retrieved from the ETSI Catalog
  62      */
  63     Optional<byte[]> getVnfPackageVnfd(final String vnfPkgId);
  64
  65     /**
  66      * GET Package Artifact, from VNF Package.
  67      *
  68      * @param vnfPkgId The ID of the VNF Package from which the artifact will be retrieved.
  69      * @param artifactPath Sequence of one or more path segments representing the path of the artifact within the VNF
  70      *        Package, e.g., foo/bar/run.sh
  71      * @return The Package Artifact of a VNF Package ("vnfPkgId", "artifactPath").
  72      */
  73     Optional<byte[]> getVnfPackageArtifact(final String vnfPkgId, final String artifactPath);
  74
  75     /**
  76      * POST the SubscriptionRequest Object.
  77      *
  78      * @return The ETSI Catalog Manager's PkgmSubscription object.
  79      */
  80     Optional<PkgmSubscription> postSubscription(
  81             final org.onap.so.adapters.vnfmadapter.extclients.etsicatalog.model.PkgmSubscriptionRequest etsiCatalogManagerSubscriptionRequest);
  82
  83     /**
  84      * DELETE the SubscriptionRequest Object.
  85      *
  86      * @return A Boolean representing if the delete was successful or not.
  87      */
  88     Boolean deleteSubscription(final String subscriptionId);
  89
  90 }