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.vnfm;
  22
  23 import com.google.common.base.Optional;
  24 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InlineResponse200;
  25 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InlineResponse2001;
  26 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InlineResponse201;
  27 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.InstantiateVnfRequest;
  28 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.LccnSubscriptionRequest;
  29 import org.onap.so.adapters.vnfmadapter.extclients.vnfm.model.TerminateVnfRequest;
  30
  31 /**
  32  * Provides methods for invoking REST calls to a VNFM.
  33  */
  34 public interface VnfmServiceProvider {
  35
  36     /**
  37      * Invoke a get request for a VNF.
  38      *
  39      * @param vnfSelfLink the link to the VNF in the VNFM
  40      * @return the VNF from the VNFM
  41      */
  42     Optional<InlineResponse201> getVnf(final String vnfSelfLink);
  43
  44     /**
  45      * Invoke an instantiate request for a VNF.
  46      *
  47      * @param vnfSelfLink the link to he VNF on the VNFM
  48      * @param instantiateVnfRequest the instantiate request
  49      * @return the operation ID of the instantiation operation
  50      */
  51     String instantiateVnf(final String vnfSelfLink, final InstantiateVnfRequest instantiateVnfRequest);
  52
  53     /**
  54      * Invoke a notification subscription request to a VNFM.
  55      *
  56      * @param vnfmId the ID of the VNFM
  57      * @param subscriptionRequest
  58      * @return the response to the subscription request
  59      */
  60     InlineResponse2001 subscribeForNotifications(final String vnfmId,
  61             final LccnSubscriptionRequest subscriptionRequest);
  62
  63     /**
  64      * Invoke a terminate request for a VNF.
  65      *
  66      * @param vnfSelfLink the link to he VNF on the VNFM
  67      * @param terminateVnfRequest the terminate request
  68      * @return the operation ID of the termination operation
  69      */
  70     String terminateVnf(final String vnfSelfLink, final TerminateVnfRequest terminateVnfRequest);
  71
  72     /**
  73      * Invoke a delete request for a VNF.
  74      *
  75      * @param vnfSelfLink the link to he VNF on the VNFM
  76      * @return the operation ID of the instantiation operation
  77      */
  78     void deleteVnf(final String vnfSelfLink);
  79
  80     /**
  81      * Invoke a get request for a VNFM operation.
  82      *
  83      * @param vnfmId the id of the VNFM in AAI
  84      * @param operationId the id of the operation on the VNFM
  85      * @return the operation from the VNFM
  86      */
  87     Optional<InlineResponse200> getOperation(final String vnfmId, final String operationId);
  88
  89 }