summaryrefslogtreecommitdiffstats
path: root/mso-api-handlers/mso-api-handler-infra/src/main/java/org/onap/so/apihandlerinfra/CamundaRequestHandler.java
blob: f30b66c6b5b3189515fb9729becd229a9761c1dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
package org.onap.so.apihandlerinfra;

import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.ws.rs.core.UriBuilder;
import javax.xml.bind.DatatypeConverter;
import org.camunda.bpm.engine.impl.persistence.entity.HistoricActivityInstanceEntity;
import org.camunda.bpm.engine.impl.persistence.entity.HistoricProcessInstanceEntity;
import org.json.JSONObject;
import org.onap.logging.filter.spring.SpringClientPayloadFilter;
import org.onap.so.logging.jaxrs.filter.SOSpringClientFilter;
import org.onap.so.utils.CryptoUtils;
import org.onap.so.apihandlerinfra.exceptions.ContactCamundaException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.ParameterizedTypeReference;
import org.springframework.core.env.Environment;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.http.client.BufferingClientHttpRequestFactory;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.retry.policy.SimpleRetryPolicy;
import org.springframework.retry.support.RetryTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.client.ResourceAccessException;
import org.springframework.web.client.RestClientException;
import org.springframework.web.client.RestTemplate;
import org.springframework.web.reactive.function.BodyInserters;
import org.springframework.web.reactive.function.client.WebClient;
import reactor.core.publisher.Flux;

@Component
public class CamundaRequestHandler {

    private static Logger logger = LoggerFactory.getLogger(CamundaRequestHandler.class);
    private static final String TIMEOUT = "30000";
    private static final String RETRY_TIMEOUT = "15000";
    private static final String TIMEOUT_PROPERTY = "mso.camunda.request.timeout";
    private static final String RETRY_TIMEOUT_PROPERTY = "mso.camunda.request.timeout.retry";

    @Autowired
    private Environment env;

    private String buildCamundaUrlString(boolean historyLookup, boolean sort, boolean active, String lookupId) {
        UriBuilder uriBuilder = UriBuilder.fromUri(env.getProperty("mso.camundaURL"));
        if (historyLookup) {
            uriBuilder.path(env.getProperty("mso.camunda.rest.history.uri"));
            uriBuilder.queryParam("processInstanceBusinessKey", lookupId);
            if (active) {
                uriBuilder.queryParam("active", true);
            }
            if (sort) {
                uriBuilder.queryParam("sortBy", "startTime");
                uriBuilder.queryParam("sortOrder", "desc");
            }
        } else {
            uriBuilder.path(env.getProperty("mso.camunda.rest.activity.uri"));
            uriBuilder.queryParam("processInstanceId", lookupId);
        }
        uriBuilder.queryParam("maxResults", 1);
        return uriBuilder.build().toString();
    }

    public ResponseEntity<List<HistoricProcessInstanceEntity>> getCamundaProcessInstanceHistory(String requestId,
            boolean retry, boolean activeOnly, boolean sort) {
        String targetUrl = buildCamundaUrlString(true, sort, activeOnly, requestId);
        HttpHeaders headers =
                setCamundaHeaders(env.getRequiredProperty("mso.camundaAuth"), env.getRequiredProperty("mso.msoKey"));

        HttpEntity<?> requestEntity = new HttpEntity<>(headers);

        if (retry) {
            RestTemplate restTemplate = getRestTemplate(retry);
            RetryTemplate retryTemplate = getRetryTemplate();
            return retryTemplate.execute(context -> {
                if (context.getLastThrowable() != null) {
                    logger.error("Retrying: Last call resulted in exception: ", context.getLastThrowable());
                }
                if (context.getRetryCount() == 0) {
                    logger.info("Querying Camunda for process-instance history for requestId: {}", requestId);
                } else {
                    logger.info(
                            "Retry: Querying Camunda for process-instance history for retryCount: {} and requestId: {}",
                            context.getRetryCount(), requestId);
                }
                return restTemplate.exchange(targetUrl, HttpMethod.GET, requestEntity,
                        new ParameterizedTypeReference<List<HistoricProcessInstanceEntity>>() {});
            });
        } else {
            RestTemplate restTemplate = getRestTemplate(retry);
            return restTemplate.exchange(targetUrl, HttpMethod.GET, requestEntity,
                    new ParameterizedTypeReference<List<HistoricProcessInstanceEntity>>() {});
        }
    }

    protected ResponseEntity<List<HistoricActivityInstanceEntity>> getCamundaActivityHistory(String processInstanceId) {
        RestTemplate restTemplate = getRestTemplate(false);
        String targetUrl = buildCamundaUrlString(false, false, false, processInstanceId);
        HttpHeaders headers =
                setCamundaHeaders(env.getRequiredProperty("mso.camundaAuth"), env.getRequiredProperty("mso.msoKey"));
        HttpEntity<?> requestEntity = new HttpEntity<>(headers);

        return restTemplate.exchange(targetUrl, HttpMethod.GET, requestEntity,
                new ParameterizedTypeReference<List<HistoricActivityInstanceEntity>>() {});
    }

    protected String getTaskName(String requestId) {
        ResponseEntity<List<HistoricProcessInstanceEntity>> response = null;

        String taskInformation = null;
        try {
            response = getCamundaProcessInstanceHistory(requestId, false, false, true);
        } catch (RestClientException e) {
            logger.warn("Error querying Camunda for process-instance history for requestId: {}, exception: {}",
                    requestId, e.getMessage());
        }

        if (response != null) {
            taskInformation = getTaskInformation(response, requestId);
        }
        return taskInformation;
    }

    protected String getTaskInformation(ResponseEntity<List<HistoricProcessInstanceEntity>> response,
            String requestId) {
        List<HistoricProcessInstanceEntity> historicProcessInstanceList = response.getBody();
        ResponseEntity<List<HistoricActivityInstanceEntity>> activityResponse = null;
        String processInstanceId = null;
        String taskInformation = null;

        if (historicProcessInstanceList != null && !historicProcessInstanceList.isEmpty()) {
            processInstanceId = historicProcessInstanceList.get(0).getId();
        } else {
            logger.warn("No processInstances returned for requestId: {} to get TaskInformation", requestId);
        }

        if (processInstanceId != null) {
            try {
                activityResponse = getCamundaActivityHistory(processInstanceId);
            } catch (RestClientException e) {
                logger.warn(
                        "Error querying Camunda for activity-instance history for processInstanceId: {}, for requestId: {}, exception: {}",
                        processInstanceId, requestId, e.getMessage());
            }
        } else {
            logger.warn("No processInstanceId returned for requestId: {} to get TaskInformation", requestId);
        }

        if (activityResponse != null) {
            taskInformation = getActivityName(activityResponse.getBody());
        } else {
            logger.warn("No activity history information returned for requestId: {} to get TaskInformation", requestId);
        }
        return taskInformation;
    }

    protected String getActivityName(List<HistoricActivityInstanceEntity> activityInstanceList) {
        String activityName = null;
        HistoricActivityInstanceEntity activityInstance = null;
        String result = null;

        if (activityInstanceList == null || activityInstanceList.isEmpty()) {
            result = "No results returned on activityInstance history lookup.";
        } else {
            activityInstance = activityInstanceList.get(0);
            activityName = activityInstance.getActivityName();

            if (activityName == null) {
                result = "Task name is null.";
            } else {
                result = "Last task executed: " + activityName;
            }
        }

        return result;
    }

    protected HttpHeaders setCamundaHeaders(String auth, String msoKey) {
        HttpHeaders headers = new HttpHeaders();
        List<org.springframework.http.MediaType> acceptableMediaTypes = new ArrayList<>();
        acceptableMediaTypes.add(org.springframework.http.MediaType.APPLICATION_JSON);
        headers.setAccept(acceptableMediaTypes);
        try {
            String userCredentials = CryptoUtils.decrypt(auth, msoKey);
            if (userCredentials != null) {
                headers.add(HttpHeaders.AUTHORIZATION,
                        "Basic " + DatatypeConverter.printBase64Binary(userCredentials.getBytes()));
            }
        } catch (GeneralSecurityException e) {
            logger.error("Security exception", e);
        }
        return headers;
    }

    protected RetryTemplate getRetryTemplate() {
        RetryTemplate retryTemplate = new RetryTemplate();
        Map<Class<? extends Throwable>, Boolean> retryableExceptions = new HashMap<>();
        retryableExceptions.put(ResourceAccessException.class, true);
        SimpleRetryPolicy policy = new SimpleRetryPolicy(2, retryableExceptions);
        retryTemplate.setRetryPolicy(policy);
        return retryTemplate;
    }

    protected void sendCamundaMessages(JSONObject msgJson) {
        String url = env.getProperty("mso.camundaURL") + "/sobpmnengine/message";
        HttpHeaders headers =
                setCamundaHeaders(env.getRequiredProperty("mso.camundaAuth"), env.getRequiredProperty("mso.msoKey"));
        headers.setContentType(org.springframework.http.MediaType.APPLICATION_JSON);
        // Workflow may take a long time so use non-blocking request
        Flux<String> flux = WebClient.create().post().uri(url).headers(httpHeaders -> {
            httpHeaders.set(httpHeaders.AUTHORIZATION, headers.get(httpHeaders.AUTHORIZATION).get(0));
            httpHeaders.set(httpHeaders.ACCEPT, headers.get(httpHeaders.ACCEPT).get(0));
            httpHeaders.set(httpHeaders.CONTENT_TYPE, headers.get(httpHeaders.CONTENT_TYPE).get(0));
        }).body(BodyInserters.fromObject(msgJson.toString())).retrieve().bodyToFlux(String.class);
        flux.subscribe(res -> logger.debug("Send Camunda Message: " + res));
    }

    protected RestTemplate getRestTemplate(boolean retry) {
        int timeout;
        if (retry) {
            timeout = Integer.parseInt(env.getProperty(RETRY_TIMEOUT_PROPERTY, RETRY_TIMEOUT));
        } else {
            timeout = Integer.parseInt(env.getProperty(TIMEOUT_PROPERTY, TIMEOUT));
        }

        RestTemplate restTemplate = new RestTemplate();
        HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
        factory.setConnectionRequestTimeout(timeout);
        factory.setReadTimeout(timeout);
        factory.setConnectTimeout(timeout);
        restTemplate.setRequestFactory(new BufferingClientHttpRequestFactory(factory));
        restTemplate.getInterceptors().add(new SOSpringClientFilter());
        restTemplate.getInterceptors().add((new SpringClientPayloadFilter()));
        return restTemplate;
    }
}