adapters/etsi-sol003-adapter/etsi-sol003-lcm/etsi-sol003-lcm-adapter/src/main/java/org/onap/so/adapters/vnfmadapter/extclients/aai/AaiServiceProvider.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.aai;
  22
  23 import org.onap.aai.domain.yang.EsrSystemInfoList;
  24 import org.onap.aai.domain.yang.EsrVnfm;
  25 import org.onap.aai.domain.yang.EsrVnfmList;
  26 import org.onap.aai.domain.yang.GenericVnf;
  27 import org.onap.aai.domain.yang.GenericVnfs;
  28 import org.onap.aai.domain.yang.Vserver;
  29 import org.onap.vnfmadapter.v1.model.Tenant;
  30
  31 /**
  32  * Provides methods for invoking REST calls to AAI.
  33  */
  34 public interface AaiServiceProvider {
  35
  36     /**
  37      * Invoke a get request for a generic VNF.
  38      *
  39      * @param vnfId the VNF id
  40      * @return the generic VNF
  41      */
  42     GenericVnf invokeGetGenericVnf(final String vnfId);
  43
  44     /**
  45      * Invoke a query for a generic VNF with the given selfLink
  46      *
  47      * @param selfLink the selfLink
  48      * @return the matching generic vnfs
  49      */
  50     GenericVnfs invokeQueryGenericVnf(final String selfLink);
  51
  52     /**
  53      * Invoke a GET request for the VNFMs.
  54      *
  55      * @return the VNFMs
  56      */
  57     EsrVnfmList invokeGetVnfms();
  58
  59     /**
  60      * Invoke a GET request for the esr system info list for a VNFM.
  61      *
  62      * @return the esr system info list for the VNFM
  63      */
  64     EsrSystemInfoList invokeGetVnfmEsrSystemInfoList(final String vnfmId);
  65
  66     /**
  67      * Invoke a GET request for the a VNFM.
  68      *
  69      * @param vnfmId the ID of the VNFM
  70      * @return the VNFM
  71      */
  72     EsrVnfm invokeGetVnfm(final String vnfmId);
  73
  74     /**
  75      * Invoke a PATCH request for a generic vnf.
  76      *
  77      * @param vnf the generic vnf
  78      * @return
  79      */
  80     void invokePatchGenericVnf(GenericVnf vnf);
  81
  82     /**
  83      * Invoke a PUT request for a relationship from a generic vnf to a VNFM.
  84      *
  85      * @param vnf the generic vnf
  86      * @param vnfmId the ID of the VNFM
  87      * @return
  88      */
  89     void invokePutGenericVnfToVnfmRelationship(GenericVnf vnf, final String vnfmId);
  90
  91
  92     /**
  93      * Invoke a PUT request for a vserver.
  94      *
  95      * @param cloudOwner the cloud owner
  96      * @param cloudRegion the cloud region
  97      * @param tenantId the ID of the tenant
  98      * @param vserver the vserver
  99      * @return
 100      */
 101     void invokePutVserver(final String cloudOwner, final String cloudRegion, final String tenantId,
 102             final Vserver vserver);
 103
 104     /**
 105      * Invoke a PUT request for a relationship from a vserver to a generic vnf.
 106      *
 107      * @param cloudOwner the cloud owner
 108      * @param cloudRegion the cloud region the vserver is deployed on
 109      * @param tenantId the ID of the tenant the vserver is deployed on
 110      * @param vserver the vserver
 111      * @param vnfId the ID of the generic vnf
 112      * @return
 113      */
 114     void invokePutVserverToVnfRelationship(final String cloudOwner, final String cloudRegion, final String tenantId,
 115             final Vserver vserver, final String vnfId);
 116
 117     /**
 118      * Invoke a DELETE request for a vserver.
 119      *
 120      * @param cloudOwner the cloud owner
 121      * @param cloudRegion the cloud region
 122      * @param tenantId the ID of the tenant
 123      * @param vserverId the ID of the vserver
 124      * @return
 125      */
 126     void invokeDeleteVserver(final String cloudOwner, final String cloudRegion, final String tenantId,
 127             final String vserverId);
 128
 129     /**
 130      * Invoke a GET request for the a tenant.
 131      *
 132      * @param cloudOwner the cloud owner
 133      * @param cloudRegion the cloud region
 134      * @param tenantId the ID of the tenant
 135      * @return the tenant
 136      */
 137     Tenant invokeGetTenant(final String cloudOwner, final String cloudRegion, final String tenantId);
 138
 139     /**
 140      * Invoke a GET request for the esr system info list for a cloud region.
 141      *
 142      * @param cloudOwner the cloud owner
 143      * @param cloudRegion the cloud region
 144      * @return the esr system info list for the VNFM
 145      */
 146     EsrSystemInfoList invokeGetCloudRegionEsrSystemInfoList(final String cloudOwner, final String cloudRegion);
 147
 148 }