Adding interfaces in documentation
[aai/sparky-be.git] / src / main / java / org / onap / aai / sparky / search / SearchServiceAdapter.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
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
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 package org.onap.aai.sparky.search;
22
23 import java.util.Arrays;
24 import java.util.HashMap;
25 import java.util.List;
26 import java.util.Map;
27
28 import javax.ws.rs.core.MediaType;
29
30 import org.onap.aai.cl.mdc.MdcContext;
31 import org.onap.aai.restclient.client.Headers;
32 import org.onap.aai.restclient.client.OperationResult;
33 import org.onap.aai.restclient.client.RestClient;
34 import org.onap.aai.sparky.dal.rest.RestClientFactory;
35 import org.onap.aai.sparky.dal.rest.config.RestEndpointConfig;
36 import org.slf4j.MDC;
37
38
39 /**
40  * The Class SearchServiceAdapter.
41  */
42 public class SearchServiceAdapter {
43
44   private static final String VALUE_QUERY = "query";
45   private static final String SUGGEST_QUERY = "suggest";
46   
47   private RestClient client;
48   private RestEndpointConfig endpointConfig;
49   private String serviceApiVersion;
50
51   private Map<String, List<String>> commonHeaders;
52
53   /**
54    * Instantiates a new search adapter.
55    * @throws Exception 
56    */
57   public SearchServiceAdapter(RestEndpointConfig endpointConfig, String serviceApiVersion) throws Exception {
58
59     client = RestClientFactory.buildClient(endpointConfig);
60
61     commonHeaders = new HashMap<String, List<String>>();
62     commonHeaders.put("Accept", Arrays.asList("application/json"));
63     commonHeaders.put(Headers.FROM_APP_ID, Arrays.asList("AAI-UI"));
64     
65     this.serviceApiVersion = serviceApiVersion;
66     this.endpointConfig = endpointConfig;
67   }
68   
69   public String getServiceApiVersion() {
70     return serviceApiVersion;
71   }
72
73   public void setServiceApiVersion(String serviceApiVersion) {
74     this.serviceApiVersion = serviceApiVersion;
75   }
76
77   public RestEndpointConfig getEndpointConfig() {
78     return endpointConfig;
79   }
80
81   public void setEndpointConfig(RestEndpointConfig endpointConfig) {
82     this.endpointConfig = endpointConfig;
83   }
84
85   public OperationResult doPost(String url, String jsonPayload, String acceptContentType) {
86     OperationResult or = client.post(url, jsonPayload, getTxnHeader(),
87         MediaType.APPLICATION_JSON_TYPE, MediaType.APPLICATION_JSON_TYPE);
88     return new OperationResult(or.getResultCode(), or.getResult());
89   }
90
91   public OperationResult doGet(String url, String acceptContentType) {
92     OperationResult or =
93         client.get(url, getTxnHeader(), MediaType.APPLICATION_JSON_TYPE);
94     return new OperationResult(or.getResultCode(), or.getResult());
95   }
96
97   public OperationResult doPut(String url, String payload, String acceptContentType) {
98     OperationResult or = client.put(url, payload, getTxnHeader(),
99         MediaType.APPLICATION_JSON_TYPE, MediaType.APPLICATION_JSON_TYPE);
100     return new OperationResult(or.getResultCode(), or.getResult());
101   }
102
103   public OperationResult doDelete(String url, String acceptContentType) {
104
105     OperationResult or =
106         client.delete(url, getTxnHeader(), MediaType.APPLICATION_JSON_TYPE);
107     return new OperationResult(or.getResultCode(), or.getResult());
108   }
109
110   public Map<String, List<String>> getTxnHeader() {
111     HashMap<String, List<String>> headers = new HashMap<String, List<String>>();
112     headers.putAll(this.commonHeaders);
113     headers.put("X-TransactionId", Arrays.asList(MDC.get(MdcContext.MDC_REQUEST_ID)));
114     headers.put("X-FromAppId", Arrays.asList(MDC.get(MdcContext.MDC_PARTNER_NAME)));
115     return headers;
116   }
117
118   /**
119    * Get Full URL for search
120    *
121    * @param api the api
122    * @param indexName
123    * @return the full url
124    */
125   public String buildSearchServiceQueryUrl(String indexName) {
126     return buildSearchServiceUrlForApi(indexName, VALUE_QUERY);
127   }
128   
129   /**
130    * Get Full URL for search
131    *
132    * @param api the api
133    * @param indexName
134    * @return the full url
135    */
136   public String buildSuggestServiceQueryUrl(String indexName) {
137     return buildSearchServiceUrlForApi(indexName, SUGGEST_QUERY);
138   }
139
140   public String buildSearchServiceUrlForApi(String indexName, String api) {
141     return String.format("https://%s:%s/services/search-data-service/%s/search/indexes/%s/%s",
142         endpointConfig.getEndpointIpAddress(), endpointConfig.getEndpointServerPort(),
143         serviceApiVersion, indexName, api);
144   }
145
146
147 }