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
9 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * SPDX-License-Identifier: Apache-2.0
18 * ============LICENSE_END=========================================================
21 package org.onap.so.adapters.vnfmadapter.extclients.etsicatalog;
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;
29 * Provides methods for invoking REST calls to the ETSI Catalog Manager.
31 * @author gareth.roper@est.tech
33 public interface EtsiCatalogServiceProvider {
36 * GET Package Content, from VNF Package.
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").
41 Optional<byte[]> getVnfPackageContent(final String vnfPkgId);
44 * GET VNF packages information from ETSI Catalog. Will return zero or more VNF package representations.
46 * @return An Array of all VNF packages retrieved from the ETSI Catalog.
48 Optional<InlineResponse2001[]> getVnfPackages();
51 * GET specific VNF package information from ETSI Catalog.
53 * @param vnfPkgId The ID of the VNF Package that you want to query.
54 * @return The VNF package retrieved from the ETSI Catalog
56 Optional<InlineResponse2001> getVnfPackage(final String vnfPkgId);
59 * GET specific VNF package VNFD from ETSI Catalog.
61 * @param vnfPkgId The ID of the VNF Package that you want to query.
62 * @return The VNF package retrieved from the ETSI Catalog
64 Optional<byte[]> getVnfPackageVnfd(final String vnfPkgId);
67 * GET Package Artifact, from VNF Package.
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").
74 Optional<byte[]> getVnfPackageArtifact(final String vnfPkgId, final String artifactPath);
77 * POST the SubscriptionRequest Object.
79 * @return The ETSI Catalog Manager's PkgmSubscription object.
81 Optional<PkgmSubscription> postSubscription(
82 final org.onap.so.adapters.vnfmadapter.extclients.etsicatalog.model.PkgmSubscriptionRequest etsiCatalogManagerSubscriptionRequest);
85 * Get the Subscription from ETSI Catalog.
87 * @param subscriptionId Subscription ID
88 * @return The Subscription {@link NsdmSubscription} from ETSI Catalog
90 Optional<NsdmSubscription> getSubscription(final String subscriptionId);
93 * DELETE the SubscriptionRequest Object.
95 * @return A Boolean representing if the delete was successful or not.
97 boolean deleteSubscription(final String subscriptionId);