aai-service/provider/src/main/java/org/onap/ccsdk/sli/adaptors/aai/AAIClient.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : SDN-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *             reserved.
   7  * Modifications Copyright © 2018 IBM.
   8  * ================================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  * ============LICENSE_END=========================================================
  21  */
  22 /**
  23  * @author Rich Tabedzki
  24  *
  25  */
  26 package org.onap.ccsdk.sli.adaptors.aai;
  27
  28 import java.io.IOException;
  29 import java.net.MalformedURLException;
  30 import java.net.URL;
  31 import java.util.Map;
  32
  33 import org.onap.aai.inventory.v14.*;
  34 import org.onap.ccsdk.sli.core.sli.SvcLogicContext;
  35 import org.onap.ccsdk.sli.core.sli.SvcLogicException;
  36 import org.onap.ccsdk.sli.core.sli.SvcLogicJavaPlugin;
  37 import org.onap.ccsdk.sli.core.sli.SvcLogicResource;
  38 import org.onap.ccsdk.sli.adaptors.aai.data.notify.NotifyEvent;
  39
  40 public interface AAIClient extends SvcLogicResource, SvcLogicJavaPlugin {
  41
  42     public SearchResults requestServiceInstanceURL(String svcInstanceId) throws AAIServiceException;
  43
  44     // VServers
  45     public Vserver requestVServerData(String tenantId, String vserverId, String cloudOwner, String cloudRegionId) throws AAIServiceException;
  46
  47     public URL requestVserverURLNodeQuery(String vserverName) throws AAIServiceException;
  48     public String getTenantIdFromVserverUrl(URL url);
  49     public String getCloudOwnerFromVserverUrl(URL url);
  50     public String getCloudRegionFromVserverUrl(URL url);
  51     public String getVServerIdFromVserverUrl(URL url, String tennantId);
  52     public Vserver requestVServerDataByURL(URL url) throws AAIServiceException;
  53
  54
  55
  56     // ----------------- Release 1510 ----------------------
  57     //    // GenericVNF
  58     public GenericVnf requestGenericVnfData(String vnfId) throws AAIServiceException;
  59     public boolean postGenericVnfData(String vnfId, GenericVnf request) throws AAIServiceException;
  60
  61     // Physical Link
  62     public PhysicalLink requestPhysicalLinkData(String vnfId) throws AAIServiceException;
  63     public boolean postPhysicalLinkData(String vnfId, PhysicalLink request) throws AAIServiceException;
  64     public boolean deletePhysicalLinkData(String vnfId, String resourceVersion) throws AAIServiceException;
  65
  66     // UBB Notify
  67     public boolean sendNotify(NotifyEvent event, String serviceInstanceId, String pathCode) throws AAIServiceException;
  68
  69     // Node Query - 1602
  70     public SearchResults requestNodeQuery(String type, String entityIdentifier, String entityName) throws AAIServiceException;
  71     public String requestDataByURL(URL url) throws AAIServiceException;
  72     public GenericVnf requestGenericVnfeNodeQuery(String vnfName) throws AAIServiceException;
  73
  74     public QueryStatus backup(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException;
  75     public QueryStatus restore(Map<String, String> params, SvcLogicContext ctx) throws SvcLogicException;
  76
  77     public void logKeyError(String keys);
  78
  79     public QueryStatus processResponseData(String rv, String resource, AAIRequest request, String prefix,  SvcLogicContext ctx, Map<String, String> nameValues, String modifier) throws IOException, AAIServiceException ;
  80     public String getPathTemplateForResource(String resoourceName, String join, SvcLogicContext ctx) throws MalformedURLException;
  81     public boolean isDeprecatedFormat(String resource, Map<String, String> nameValues);
  82
  83     String query(AAIRequest request) throws AAIServiceException;
  84     String save(AAIRequest request) throws AAIServiceException;
  85     boolean delete(AAIRequest request, String resourceVersion) throws AAIServiceException;
  86     boolean update(AAIRequest request, String resourceVersion) throws AAIServiceException;
  87
  88 }