2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017-2018 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
12 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.aai.sa.searchdbabstraction.elasticsearch.dao;
23 import org.onap.aai.sa.rest.BulkRequest;
24 import org.onap.aai.sa.searchdbabstraction.elasticsearch.exception.DocumentStoreOperationException;
25 import org.onap.aai.sa.searchdbabstraction.entity.DocumentOperationResult;
26 import org.onap.aai.sa.searchdbabstraction.entity.OperationResult;
27 import org.onap.aai.sa.searchdbabstraction.entity.SearchOperationResult;
28 import org.onap.aai.sa.rest.DocumentSchema;
30 public interface DocumentStoreInterface {
32 public OperationResult createIndex(String index, DocumentSchema documentSchema);
34 public OperationResult createDynamicIndex(String index, String dynamicSchema);
36 public OperationResult deleteIndex(String indexName) throws DocumentStoreOperationException;
38 public DocumentOperationResult createDocument(String indexName, DocumentStoreDataEntity document,
39 boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
41 public DocumentOperationResult updateDocument(String indexName, DocumentStoreDataEntity document,
42 boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
44 public DocumentOperationResult deleteDocument(String indexName, DocumentStoreDataEntity document)
45 throws DocumentStoreOperationException;
47 public DocumentOperationResult getDocument(String indexName, DocumentStoreDataEntity document)
48 throws DocumentStoreOperationException;
50 public SearchOperationResult search(String indexName, String queryText)
51 throws DocumentStoreOperationException;
53 public SearchOperationResult searchWithPayload(String indexName, String query)
54 throws DocumentStoreOperationException;
56 public SearchOperationResult suggestionQueryWithPayload(String indexName, String query)
57 throws DocumentStoreOperationException;
60 * Forwards a set of operations to the document store as a single, bulk request.
62 * @param anIndex - The index to apply the operations to.
63 * @param operations - A java object containing the set of operations to be performed.
64 * @return - An operation result.
65 * @throws DocumentStoreOperationException
67 public OperationResult performBulkOperations(BulkRequest[] request)
68 throws DocumentStoreOperationException;