src/main/java/org/openecomp/sa/searchdbabstraction/elasticsearch/dao/DocumentStoreInterface.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.openecomp.sa.searchdbabstraction.elasticsearch.dao;
  24
  25
  26 import org.openecomp.sa.rest.BulkRequest;
  27 import org.openecomp.sa.rest.DocumentSchema;
  28 import org.openecomp.sa.searchdbabstraction.elasticsearch.exception.DocumentStoreOperationException;
  29 import org.openecomp.sa.searchdbabstraction.entity.DocumentOperationResult;
  30 import org.openecomp.sa.searchdbabstraction.entity.OperationResult;
  31 import org.openecomp.sa.searchdbabstraction.entity.SearchOperationResult;
  32
  33
  34 public interface DocumentStoreInterface {
  35
  36   public OperationResult createIndex(String index, DocumentSchema documentSchema);
  37
  38   public OperationResult deleteIndex(String indexName) throws DocumentStoreOperationException;
  39
  40   public DocumentOperationResult createDocument(String indexName,
  41                                                 DocumentStoreDataEntity document,
  42                                                 boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
  43
  44   public DocumentOperationResult updateDocument(String indexName,
  45                                                 DocumentStoreDataEntity document,
  46                                                 boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
  47
  48   public DocumentOperationResult deleteDocument(String indexName, DocumentStoreDataEntity document)
  49       throws DocumentStoreOperationException;
  50
  51   public DocumentOperationResult getDocument(String indexName, DocumentStoreDataEntity document)
  52       throws DocumentStoreOperationException;
  53
  54   public SearchOperationResult search(String indexName, String queryText)
  55       throws DocumentStoreOperationException;
  56
  57   public SearchOperationResult searchWithPayload(String indexName, String query)
  58       throws DocumentStoreOperationException;
  59
  60
  61   /**
  62    * Forwards a set of operations to the document store as a single, bulk
  63    * request.
  64    *
  65    * @param anIndex    - The index to apply the operations to.
  66    * @param operations - A java object containing the set of operations to
  67    *                   be performed.
  68    * @return - An operation result.
  69    * @throws DocumentStoreOperationException
  70    */
  71   public OperationResult performBulkOperations(BulkRequest[] request)
  72       throws DocumentStoreOperationException;
  73 }