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