src/main/java/org/onap/aai/sparky/dal/elasticsearch/ElasticSearchDataProvider.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.elasticsearch;
  24
  25 import org.onap.aai.sparky.dal.rest.OperationResult;
  26 import org.onap.aai.sparky.dal.rest.RestDataProvider;
  27
  28 /*
  29  * TODO:   DELETE ME
  30  */
  31
  32 /**
  33  * The Interface ElasticSearchDataProvider.
  34  */
  35 public interface ElasticSearchDataProvider extends RestDataProvider {
  36
  37   /**
  38    * Builds the bulk import operation request.
  39    *
  40    * @param index the index
  41    * @param type the type
  42    * @param id the id
  43    * @param version the version
  44    * @param payload the payload
  45    * @return the string
  46    */
  47   String buildBulkImportOperationRequest(String index, String type, String id, String version,
  48       String payload);
  49
  50   /**
  51    * Do bulk operation.
  52    *
  53    * @param url the url
  54    * @param payload the payload
  55    * @return the operation result
  56    */
  57   OperationResult doBulkOperation(String url, String payload);
  58
  59   OperationResult retrieveEntityById(String entityId) throws Exception;
  60
  61   /*
  62    * (non-Javadoc)
  63    *
  64    * @see org.openecomp.sparky.dal.rest.RestDataProvider#shutdown()
  65    */
  66   @Override
  67   void shutdown();
  68
  69 }