src/main/java/org/onap/aai/sparky/dal/aai/ActiveInventoryDataProvider.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  */
  23 package org.onap.aai.sparky.dal.aai;
  24
  25 import java.util.List;
  26
  27 import org.onap.aai.sparky.dal.rest.OperationResult;
  28 import org.onap.aai.sparky.dal.rest.RestDataProvider;
  29
  30 /**
  31  * The Interface ActiveInventoryDataProvider.
  32  */
  33
  34 /*
  35  * TODO: DELETE ME
  36  */
  37
  38 public interface ActiveInventoryDataProvider extends RestDataProvider {
  39
  40   /**
  41    * Gets the self links by entity type.
  42    *
  43    * @param entityType the entity type
  44    * @return the self links by entity type
  45    * @throws Exception the exception
  46    */
  47   /*
  48    * This one will do the nodes-query and understand enough to make that happen
  49    */
  50   OperationResult getSelfLinksByEntityType(String entityType) throws Exception;
  51
  52   /**
  53    * Gets the self link for entity.
  54    *
  55    * @param entityType the entity type
  56    * @param primaryKeyName the primary key name
  57    * @param primaryKeyValue the primary key value
  58    * @return the self link for entity
  59    * @throws Exception the exception
  60    */
  61   OperationResult getSelfLinkForEntity(String entityType, String primaryKeyName,
  62       String primaryKeyValue) throws Exception;
  63
  64   /**
  65    * Query active inventory with retries.
  66    *
  67    * @param url the url
  68    * @param responseType the response type
  69    * @param numRetries the num retries
  70    * @return the operation result
  71    */
  72   OperationResult queryActiveInventoryWithRetries(String url, String responseType, int numRetries);
  73
  74
  75   /**
  76    * Determines the self-link for an entity with passed-in key-value pairs.
  77    *
  78    * @param startNodeType
  79    * @param keyParams
  80    * @return
  81    * @throws Exception
  82    */
  83   String getGenericQueryForSelfLink(String startNodeType, List<String> queryKeyParams)
  84       throws Exception;
  85
  86   /*
  87    * (non-Javadoc)
  88    *
  89    * @see org.openecomp.sparky.dal.rest.RestDataProvider#shutdown()
  90    */
  91   @Override
  92   void shutdown();
  93
  94 }