* so
* ================================================================================
* Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2019 Nordix Foundation.
+ * Modifications Copyright (C) 2019-2020 Nordix Foundation.
* Modifications Copyright (C) 2019 Samsung Electronics Co., Ltd.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
-import org.drools.core.WorkingMemory;
+import org.apache.commons.lang3.tuple.Pair;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
-import org.onap.policy.drools.system.PolicyEngine;
import org.onap.policy.rest.RestManager;
-import org.onap.policy.rest.RestManager.Pair;
import org.onap.policy.so.util.Serialization;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
/**
- * This class handles the interface towards SO (Service Orchestrator) for the ONAP Policy
- * Framework. The SO API is defined at this link:
+ * This class handles the interface towards SO (Service Orchestrator) for the ONAP Policy Framework. The SO API is
+ * defined at this link:
* http://onap.readthedocs.io/en/latest/submodules/so.git/docs/SO_R1_Interface.html#get-orchestration-request
*
*/
public final class SoManager {
+
+ // TODO remove this class
+
private static final Logger logger = LoggerFactory.getLogger(SoManager.class);
private static ExecutorService executors = Executors.newCachedThreadPool();
private long restGetTimeout = GET_REQUEST_WAIT_INTERVAL;
+ private String url;
+ private String user;
+ private String password;
+
+ @FunctionalInterface
+ public interface SoCallback {
+ public void onSoResponseWrapper(SoResponseWrapper wrapper);
+ }
+
/**
* Default constructor.
*/
- public SoManager() {
+ public SoManager(String url, String user, String password) {
+ this.url = url;
+ this.user = user;
+ this.password = password;
restManager = new RestManager();
}
* @return the SO Response object
*/
public SoResponse createModuleInstance(final String url, final String urlBase, final String username,
- final String password, final SoRequest request) {
+ final String password, final SoRequest request) {
// Issue the HTTP POST request to SO to create the service instance
String requestJson = Serialization.gsonPretty.toJson(request);
NetLoggerUtil.getNetworkLogger().info("[OUT|{}|{}|{}|{}|{}|{}|]{}{}", "SO", url, username, password,
- createSimpleHeaders(), MEDIA_TYPE, LINE_SEPARATOR, requestJson);
+ createSimpleHeaders(), MEDIA_TYPE, LINE_SEPARATOR, requestJson);
Pair<Integer, String> httpResponse =
- restManager.post(url, username, password, createSimpleHeaders(), MEDIA_TYPE, requestJson);
+ restManager.post(url, username, password, createSimpleHeaders(), MEDIA_TYPE, requestJson);
// Process the response from SO
SoResponse response = waitForSoOperationCompletion(urlBase, username, password, url, httpResponse);
}
/**
- * Works just like SOManager#asyncSORestCall(String, WorkingMemory, String, String, String, SORequest)
- * except the vfModuleInstanceId is always null.
+ * Works just like SOManager#asyncSORestCall(String, WorkingMemory, String, String, String, SORequest) except the
+ * vfModuleInstanceId is always null.
*
*/
- public Future<SoResponse> asyncSoRestCall(final String requestId, final WorkingMemory wm,
- final String serviceInstanceId, final String vnfInstanceId,
- final SoRequest request) {
- return asyncSoRestCall(requestId, wm, serviceInstanceId, vnfInstanceId, null, request);
+ public Future<SoResponse> asyncSoRestCall(final String requestId, final SoCallback callback,
+ final String serviceInstanceId, final String vnfInstanceId, final SoRequest request) {
+ return asyncSoRestCall(requestId, callback, serviceInstanceId, vnfInstanceId, null, request);
}
/**
- * This method makes an asynchronous Rest call to MSO and inserts the response into
- * Drools working memory.
+ * This method makes an asynchronous Rest call to MSO and inserts the response into Drools working memory.
*
- * @param requestId the request id
- * @param wm the Drools working memory
- * @param serviceInstanceId service instance id to construct the request url
- * @param vnfInstanceId vnf instance id to construct the request url
+ * @param requestId the request id
+ * @param callback callback method
+ * @param serviceInstanceId service instance id to construct the request url
+ * @param vnfInstanceId vnf instance id to construct the request url
* @param vfModuleInstanceId vfModule instance id to construct the request url (required in case of delete vf
- * module)
- * @param request the SO request
+ * module)
+ * @param request the SO request
* @return a concurrent Future for the thread that handles the request
*/
- public Future<SoResponse> asyncSoRestCall(final String requestId,
- final WorkingMemory wm,
- final String serviceInstanceId,
- final String vnfInstanceId,
- final String vfModuleInstanceId, final SoRequest request) {
- return executors.submit(new AsyncSoRestCallThread(requestId, wm, serviceInstanceId, vnfInstanceId,
- vfModuleInstanceId, request));
+ public Future<SoResponse> asyncSoRestCall(final String requestId, final SoCallback callback,
+ final String serviceInstanceId, final String vnfInstanceId, final String vfModuleInstanceId,
+ final SoRequest request) {
+ return executors.submit(new AsyncSoRestCallThread(requestId, callback, serviceInstanceId, vnfInstanceId,
+ vfModuleInstanceId, request, this));
}
/**
*/
private class AsyncSoRestCallThread implements Callable<SoResponse> {
final String requestId;
- final WorkingMemory wm;
+ final SoCallback callback;
final String serviceInstanceId;
final String vnfInstanceId;
final String vfModuleInstanceId;
final SoRequest request;
+ final String baseUrl;
+ final String user;
+ final String password;
/**
* Constructor, sets the context of the request.
*
- * @param requestID The request ID
- * @param wm reference to the Drools working memory
- * @param serviceInstanceId the service instance in SO to use
- * @param vnfInstanceId the VNF instance that is the subject of the request
+ * @param requestID The request ID
+ * @param wm reference to the Drools working memory
+ * @param serviceInstanceId the service instance in SO to use
+ * @param vnfInstanceId the VNF instance that is the subject of the request
* @param vfModuleInstanceId the vf module instance id (not null in case of delete vf module request)
- * @param request the request itself
+ * @param request the request itself
*/
- private AsyncSoRestCallThread(final String requestId,
- final WorkingMemory wm, final String serviceInstanceId,
- final String vnfInstanceId, final String vfModuleInstanceId,
- final SoRequest request) {
+ private AsyncSoRestCallThread(final String requestId, final SoCallback callback, final String serviceInstanceId,
+ final String vnfInstanceId, final String vfModuleInstanceId, final SoRequest request,
+ final SoManager callingSoManager) {
this.requestId = requestId;
- this.wm = wm;
+ this.callback = callback;
this.serviceInstanceId = serviceInstanceId;
this.vnfInstanceId = vnfInstanceId;
this.vfModuleInstanceId = vfModuleInstanceId;
this.request = request;
+ this.baseUrl = callingSoManager.url;
+ this.user = callingSoManager.user;
+ this.password = callingSoManager.password;
}
/**
*/
@Override
public SoResponse call() {
- String urlBase = PolicyEngine.manager.getEnvironmentProperty("so.url");
- String username = PolicyEngine.manager.getEnvironmentProperty("so.username");
- String password = PolicyEngine.manager.getEnvironmentProperty("so.password");
// Create a JSON representation of the request
String soJson = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create().toJson(request);
- String url = null;
+ String initialUrl = null;
Pair<Integer, String> httpResponse = null;
- if (request.getOperationType() != null && request.getOperationType()
- .equals(SoOperationType.SCALE_OUT)) {
- url = urlBase + "/serviceInstantiation/v7/serviceInstances/" + serviceInstanceId + "/vnfs/"
- + vnfInstanceId + "/vfModules/scaleOut";
- NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, url, soJson);
- httpResponse = restManager.post(url, username, password, createSimpleHeaders(), MEDIA_TYPE, soJson);
- } else if (request.getOperationType() != null && request.getOperationType()
- .equals(SoOperationType.DELETE_VF_MODULE)) {
- url = urlBase + "/serviceInstances/v7/" + serviceInstanceId + "/vnfs/" + vnfInstanceId
+ if (request.getOperationType() != null && request.getOperationType().equals(SoOperationType.SCALE_OUT)) {
+ initialUrl = this.baseUrl + "/serviceInstantiation/v7/serviceInstances/" + serviceInstanceId + "/vnfs/"
+ + vnfInstanceId + "/vfModules/scaleOut";
+ NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, initialUrl, soJson);
+ httpResponse = restManager.post(initialUrl, this.user, this.password, createSimpleHeaders(), MEDIA_TYPE,
+ soJson);
+ } else if (request.getOperationType() != null
+ && request.getOperationType().equals(SoOperationType.DELETE_VF_MODULE)) {
+ initialUrl = this.baseUrl + "/serviceInstances/v7/" + serviceInstanceId + "/vnfs/" + vnfInstanceId
+ "/vfModules/" + vfModuleInstanceId;
- NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, url, soJson);
- httpResponse = restManager.delete(url, username, password, createSimpleHeaders(), MEDIA_TYPE, soJson);
+ NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, initialUrl, soJson);
+ httpResponse = restManager.delete(initialUrl, this.user, this.password, createSimpleHeaders(),
+ MEDIA_TYPE, soJson);
} else {
return null;
}
// Process the response from SO
- SoResponse response = waitForSoOperationCompletion(urlBase, username, password, url, httpResponse);
+ SoResponse response =
+ waitForSoOperationCompletion(this.baseUrl, this.user, this.password, initialUrl, httpResponse);
// Return the response to Drools in its working memory
SoResponseWrapper soWrapper = new SoResponseWrapper(response, requestId);
- wm.insert(soWrapper);
+ if (this.callback != null) {
+ this.callback.onSoResponseWrapper(soWrapper);
+ }
return response;
}
* @return The parsed final response of SO to the request
*/
private SoResponse waitForSoOperationCompletion(final String urlBaseSo, final String username,
- final String password, final String initialRequestUrl,
- final Pair<Integer, String> initialHttpResponse) {
+ final String password, final String initialRequestUrl, final Pair<Integer, String> initialHttpResponse) {
// Process the initial response from SO, the response to a post
SoResponse response = processSoResponse(initialRequestUrl, initialHttpResponse);
if (SO_RESPONSE_ERROR == response.getHttpResponseCode()) {
// Issue a GET to find the current status of our request
NetLoggerUtil.getNetworkLogger().info("[OUT|{}|{}|{}|{}|{}|{}|]{}", "SO", urlGet, username, password,
- createSimpleHeaders(), MEDIA_TYPE, LINE_SEPARATOR);
+ createSimpleHeaders(), MEDIA_TYPE, LINE_SEPARATOR);
Pair<Integer, String> httpResponse = restManager.get(urlGet, username, password, createSimpleHeaders());
// Get our response
// A null httpDetails indicates a HTTP problem, a valid response from SO must be
// either 200
// or 202
- if (!httpResultIsNullFree(httpResponse) || (httpResponse.first != 200 && httpResponse.first != 202)) {
+ if (!httpResultIsNullFree(httpResponse) || (httpResponse.getLeft() != 200 && httpResponse.getLeft() != 202)) {
logger.error("Invalid HTTP response received from SO");
response.setHttpResponseCode(SO_RESPONSE_ERROR);
return response;
// Parse the JSON of the response into our POJO
try {
- response = Serialization.gsonPretty.fromJson(httpResponse.second, SoResponse.class);
+ response = Serialization.gsonPretty.fromJson(httpResponse.getRight(), SoResponse.class);
} catch (JsonSyntaxException e) {
logger.error("Failed to deserialize HTTP response into SOResponse: ", e);
response.setHttpResponseCode(SO_RESPONSE_ERROR);
// Set the HTTP response code of the response if needed
if (response.getHttpResponseCode() == 0) {
- response.setHttpResponseCode(httpResponse.first);
+ response.setHttpResponseCode(httpResponse.getLeft());
}
- NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, requestUrl, httpResponse.second);
+ NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, requestUrl, httpResponse.getRight());
if (logger.isDebugEnabled()) {
logger.debug("***** Response to SO Request to URL {}:", requestUrl);
- logger.debug(httpResponse.second);
+ logger.debug(httpResponse.getRight());
}
return response;
*/
private boolean isRequestStateDefined(final SoResponse response) {
return response != null && response.getRequest() != null && response.getRequest().getRequestStatus() != null
- && response.getRequest().getRequestStatus().getRequestState() != null;
+ && response.getRequest().getRequestStatus().getRequestState() != null;
}
/**
* @return true if the request for the response is finished
*/
private boolean isRequestStateFinished(final Pair<Integer, String> latestHttpDetails, final SoResponse response) {
- if (latestHttpDetails != null && 200 == latestHttpDetails.first && isRequestStateDefined(response)) {
+ if (latestHttpDetails != null && 200 == latestHttpDetails.getLeft() && isRequestStateDefined(response)) {
String requestState = response.getRequest().getRequestStatus().getRequestState();
return "COMPLETE".equalsIgnoreCase(requestState) || "FAILED".equalsIgnoreCase(requestState);
} else {
* @return true if no nulls are found
*/
private boolean httpResultIsNullFree(Pair<Integer, String> httpOperationResult) {
- return httpOperationResult != null && httpOperationResult.first != null && httpOperationResult.second != null;
+ return httpOperationResult != null && httpOperationResult.getLeft() != null
+ && httpOperationResult.getRight() != null;
}
/**
Code Review / policy / models.git / blobdiff