src/main/java/org/openecomp/sparky/dal/elasticsearch/ElasticSearchDataProvider.java

   1 /**
   2  * ============LICENSE_START===================================================
   3  * SPARKY (AAI UI service)
   4  * ============================================================================
   5  * Copyright © 2017 AT&T Intellectual Property.
   6  * Copyright © 2017 Amdocs
   7  * All rights reserved.
   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  * ECOMP and OpenECOMP are trademarks
  23  * and service marks of AT&T Intellectual Property.
  24  */
  25
  26 package org.openecomp.sparky.dal.elasticsearch;
  27
  28 import org.openecomp.sparky.dal.rest.OperationResult;
  29 import org.openecomp.sparky.dal.rest.RestDataProvider;
  30
  31 /**
  32  * The Interface ElasticSearchDataProvider.
  33  */
  34 public interface ElasticSearchDataProvider extends RestDataProvider {
  35
  36   /**
  37    * Builds the bulk import operation request.
  38    *
  39    * @param index the index
  40    * @param type the type
  41    * @param id the id
  42    * @param version the version
  43    * @param payload the payload
  44    * @return the string
  45    */
  46   String buildBulkImportOperationRequest(String index, String type, String id, String version,
  47       String payload);
  48
  49   /**
  50    * Do bulk operation.
  51    *
  52    * @param url the url
  53    * @param payload the payload
  54    * @return the operation result
  55    */
  56   OperationResult doBulkOperation(String url, String payload);
  57
  58   OperationResult retrieveEntityById(String entityId) throws Exception;
  59
  60   /* (non-Javadoc)
  61    * @see org.openecomp.sparky.dal.rest.RestDataProvider#shutdown()
  62    */
  63   @Override
  64   void shutdown();
  65
  66 }