2 * ============LICENSE_START=======================================================
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
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 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
23 package org.openecomp.sparky.dal.aai;
25 import java.util.List;
27 import org.openecomp.sparky.dal.rest.OperationResult;
28 import org.openecomp.sparky.dal.rest.RestDataProvider;
31 * The Interface ActiveInventoryDataProvider.
33 public interface ActiveInventoryDataProvider extends RestDataProvider {
36 * Gets the self links by entity type.
38 * @param entityType the entity type
39 * @return the self links by entity type
40 * @throws Exception the exception
43 * This one will do the nodes-query and understand enough to make that happen
45 OperationResult getSelfLinksByEntityType(String entityType) throws Exception;
48 * Gets the self link for entity.
50 * @param entityType the entity type
51 * @param primaryKeyName the primary key name
52 * @param primaryKeyValue the primary key value
53 * @return the self link for entity
54 * @throws Exception the exception
56 OperationResult getSelfLinkForEntity(String entityType, String primaryKeyName,
57 String primaryKeyValue) throws Exception;
60 * Query active inventory with retries.
63 * @param responseType the response type
64 * @param numRetries the num retries
65 * @return the operation result
67 OperationResult queryActiveInventoryWithRetries(String url, String responseType, int numRetries);
71 * Determines the self-link for an entity with passed-in key-value pairs.
73 * @param startNodeType
78 String getGenericQueryForSelfLink(String startNodeType, List<String> queryKeyParams) throws Exception;
83 * @see org.openecomp.sparky.dal.rest.RestDataProvider#shutdown()