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