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;
24 import org.onap.aai.sa.rest.BulkRequest;
25 import org.onap.aai.sa.searchdbabstraction.elasticsearch.exception.DocumentStoreOperationException;
26 import org.onap.aai.sa.searchdbabstraction.entity.DocumentOperationResult;
27 import org.onap.aai.sa.searchdbabstraction.entity.OperationResult;
28 import org.onap.aai.sa.searchdbabstraction.entity.SearchOperationResult;
29 import org.onap.aai.sa.rest.DocumentSchema;
32 public interface DocumentStoreInterface {
34 public OperationResult createIndex(String index, DocumentSchema documentSchema);
36 public OperationResult deleteIndex(String indexName) throws DocumentStoreOperationException;
38 public DocumentOperationResult createDocument(String indexName,
39 DocumentStoreDataEntity document,
40 boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
42 public DocumentOperationResult updateDocument(String indexName,
43 DocumentStoreDataEntity document,
44 boolean allowImplicitIndexCreation) throws DocumentStoreOperationException;
46 public DocumentOperationResult deleteDocument(String indexName, DocumentStoreDataEntity document)
47 throws DocumentStoreOperationException;
49 public DocumentOperationResult getDocument(String indexName, DocumentStoreDataEntity document)
50 throws DocumentStoreOperationException;
52 public SearchOperationResult search(String indexName, String queryText)
53 throws DocumentStoreOperationException;
55 public SearchOperationResult searchWithPayload(String indexName, String query)
56 throws DocumentStoreOperationException;
60 * Forwards a set of operations to the document store as a single, bulk
63 * @param anIndex - The index to apply the operations to.
64 * @param operations - A java object containing the set of operations to
66 * @return - An operation result.
67 * @throws DocumentStoreOperationException
69 public OperationResult performBulkOperations(BulkRequest[] request)
70 throws DocumentStoreOperationException;