adapters/mso-vnfm-adapter/mso-vnfm-etsi-adapter/src/main/java/org/onap/so/adapters/vnfmadapter/extclients/etsicatalog/EtsiCatalogServiceProvider.java

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