Respect owning-entity-id when searching instances by Subscriber
[vid.git] / vid-app-common / src / main / java / org / onap / vid / aai / AaiClientInterface.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * VID
4  * ================================================================================
5  * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
6  * ================================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END=========================================================
19  */
20
21 package org.onap.vid.aai;
22
23 import com.fasterxml.jackson.databind.JsonNode;
24 import java.net.URI;
25 import java.util.List;
26 import java.util.Map;
27 import javax.ws.rs.core.Response;
28 import org.onap.vid.aai.model.AaiGetOperationalEnvironments.OperationalEnvironmentList;
29 import org.onap.vid.aai.model.AaiGetPnfs.Pnf;
30 import org.onap.vid.aai.model.AaiGetTenatns.GetTenantsResponse;
31 import org.onap.vid.aai.model.ModelVer;
32 import org.onap.vid.aai.model.PortDetailsTranslator;
33 import org.onap.vid.aai.model.Properties;
34 import org.onap.vid.aai.model.ResourceType;
35 import org.onap.vid.model.SubscriberList;
36 import org.onap.vid.services.ProbeInterface;
37 import org.springframework.http.HttpMethod;
38
39 /**
40  * Created by Oren on 7/4/17.
41  */
42 public interface AaiClientInterface extends ProbeInterface {
43
44     boolean isNodeTypeExistsByName(String name, ResourceType type);
45
46     <T> T typedAaiGet(URI path, Class<T> clz);
47
48     <T> T typedAaiRest(URI path, Class<T> clz, String payload, HttpMethod method, boolean propagateExceptions);
49
50     AaiResponse<SubscriberList> getAllSubscribers();
51
52     AaiResponse<Services> getSubscriberData(String subscriberId, boolean omitServiceInstances);
53
54     AaiResponse getServices();
55
56     AaiResponse getServicesByOwningEntityId(List<String> owningEntityIds);
57
58     AaiResponse<GetTenantsResponse[]> getTenants(String globalCustomerId, String serviceType);
59
60     AaiResponse<OperationalEnvironmentList> getOperationalEnvironments(String operationalEnvironmentType, String operationalEnvironmentStatus);
61
62     AaiResponse getAllAicZones();
63
64     AaiResponse getNetworkCollectionDetails(String serviceInstanceId);
65
66     AaiResponse getInstanceGroupsByCloudRegion(String cloudOwner, String cloudRegionId, String networkFunction);
67
68     AaiResponse<AaiGetVnfResponse> getVNFData(String globalSubscriberId, String serviceType);
69
70     AaiResponse getVNFData(String globalSubscriberId, String serviceType, String serviceInstanceId);
71
72     AaiResponse getNodeTemplateInstances(String globalCustomerId, String serviceType, String modelVersionId, String modelInvariantId, String cloudRegion);
73
74     Response getVersionByInvariantId(List<String> modelInvariantId);
75
76     ModelVer getLatestVersionByInvariantId(String modelInvariantId);
77
78     AaiResponse getServicesByProjectNames(List<String> projectNames);
79
80     AaiResponse getServiceModelsByDistributionStatus();
81
82     AaiResponse getPNFData(String globalCustomerId, String serviceType, String modelVersionId, String modelInvariantId, String cloudRegion, String equipVendor, String equipModel);
83
84     AaiResponse<Pnf> getSpecificPnf(String pnfId);
85
86     AaiResponse getServiceInstance(String globalCustomerId, String serviceType, String serviceInstanceId);
87
88     AaiResponse getLogicalLink(String link);
89
90     AaiResponse<JsonNode> getCloudRegionAndSourceByPortMirroringConfigurationId(String configurationId);
91
92     List<PortDetailsTranslator.PortDetails> getPortMirroringSourcePorts(String configurationID);
93
94     AaiResponse getInstanceGroupsByVnfInstanceId(String vnfInstanceId);
95
96     Response doAaiGet(String uri, boolean xml);
97
98     String getCloudOwnerByCloudRegionId(String cloudRegionId);
99
100     GetTenantsResponse getHomingDataByVfModule(String vnfInstanceId, String vfModuleId);
101
102     void resetCache(String cacheName);
103
104     Map<String, Properties> getCloudRegionAndTenantByVnfId(String vnfId);
105
106     AaiResponse<AaiGetVnfResponse> getVnfsByParamsForChangeManagement(String subscriberId, String serviceType, String nfRole, String cloudRegion);
107 }