migrate model-impl from drools-applications

migrate controlloop/common/model-impl from drools-applicaitons to
policy/models

Issue-ID: POLICY-1264
Change-Id: Ibe0bb5c49a7b1344f4104b30455f52834041e187
Signed-off-by: Hengye <yehui.wang@est.tech>

21 files changed, 2052 insertions, 0 deletions

diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoAsyncRequestStatus.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoAsyncRequestStatus.java
new file mode 100644
index 000000000..cd4922dbd
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoAsyncRequestStatus.java
@@ -0,0 +1,126 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+import java.time.LocalDateTime;
+
+public class SoAsyncRequestStatus implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("correlator")
+    private String correlator;
+
+    @SerializedName("requestId")
+    private String requestId;
+
+    @SerializedName("instanceReferences")
+    private SoInstanceReferences instanceReferences;
+
+    @SerializedName("startTime")
+    private LocalDateTime startTime;
+
+    @SerializedName("finishTime")
+    private LocalDateTime finishTime;
+
+    @SerializedName("requestScope")
+    private String requestScope;
+
+    @SerializedName("requestType")
+    private String requestType;
+
+    @SerializedName("requestStatus")
+    private SoRequestStatus requestStatus;
+
+    public SoAsyncRequestStatus() {
+        // required by author
+    }
+
+    public String getCorrelator() {
+        return correlator;
+    }
+
+
+    public LocalDateTime getFinishTime() {
+        return finishTime;
+    }
+
+    public SoInstanceReferences getInstanceReferences() {
+        return instanceReferences;
+    }
+
+    public String getRequestId() {
+        return requestId;
+    }
+
+    public String getRequestScope() {
+        return requestScope;
+    }
+
+    public SoRequestStatus getRequestStatus() {
+        return requestStatus;
+    }
+
+    public String getRequestType() {
+        return requestType;
+    }
+
+    public LocalDateTime getStartTime() {
+        return startTime;
+    }
+
+    public void setCorrelator(String correlator) {
+        this.correlator = correlator;
+    }
+
+    public void setFinishTime(LocalDateTime finishTime) {
+        this.finishTime = finishTime;
+    }
+
+    public void setInstanceReferences(SoInstanceReferences instanceReferences) {
+        this.instanceReferences = instanceReferences;
+    }
+
+    public void setRequestId(String requestId) {
+        this.requestId = requestId;
+    }
+
+    public void setRequestScope(String requestScope) {
+        this.requestScope = requestScope;
+    }
+
+    public void setRequestStatus(SoRequestStatus requestStatus) {
+        this.requestStatus = requestStatus;
+    }
+
+    public void setRequestType(String requestType) {
+        this.requestType = requestType;
+    }
+
+    public void setStartTime(LocalDateTime startTime) {
+        this.startTime = startTime;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoCloudConfiguration.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoCloudConfiguration.java
new file mode 100644
index 000000000..e6512685b
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoCloudConfiguration.java
@@ -0,0 +1,58 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoCloudConfiguration implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("lcpCloudRegionId")
+    private String lcpCloudRegionId;
+
+    @SerializedName("tenantId")
+    private String tenantId;
+
+    public SoCloudConfiguration() {
+        //required by author
+    }
+
+    public String getLcpCloudRegionId() {
+        return lcpCloudRegionId;
+    }
+
+    public String getTenantId() {
+        return tenantId;
+    }
+
+    public void setLcpCloudRegionId(String lcpCloudRegionId) {
+        this.lcpCloudRegionId = lcpCloudRegionId;
+    }
+
+    public void setTenantId(String tenantId) {
+        this.tenantId = tenantId;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoInstanceReferences.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoInstanceReferences.java
new file mode 100644
index 000000000..751f560c0
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoInstanceReferences.java
@@ -0,0 +1,58 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoInstanceReferences implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("requestId")
+    private String requestId;
+
+    @SerializedName("instanceId")
+    private String instanceId;
+
+    public SoInstanceReferences() {
+        //requried by author
+    }
+
+    public String getInstanceId() {
+        return instanceId;
+    }
+
+    public String getRequestId() {
+        return requestId;
+    }
+
+    public void setInstanceId(String instanceId) {
+        this.instanceId = instanceId;
+    }
+
+    public void setRequestId(String requestId) {
+        this.requestId = requestId;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoManager.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoManager.java
new file mode 100644
index 000000000..4c9ba66bd
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoManager.java
@@ -0,0 +1,375 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * Modifications Copyright (C) 2019 Samsung Electronics Co., Ltd.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonSyntaxException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.concurrent.Callable;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import org.drools.core.WorkingMemory;
+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:
+ * http://onap.readthedocs.io/en/latest/submodules/so.git/docs/SO_R1_Interface.html#get-orchestration-request
+ *
+ */
+public final class SoManager {
+    private static final Logger logger = LoggerFactory.getLogger(SoManager.class);
+
+    private static ExecutorService executors = Executors.newCachedThreadPool();
+
+    private static final int SO_RESPONSE_ERROR = 999;
+    private static final String MEDIA_TYPE = "application/json";
+    private static final String LINE_SEPARATOR = System.lineSeparator();
+
+    // REST get timeout value in milliseconds
+    private static final int GET_REQUESTS_BEFORE_TIMEOUT = 20;
+    private static final long GET_REQUEST_WAIT_INTERVAL = 20000;
+
+    // The REST manager used for processing REST calls for this VFC manager
+    private RestManager restManager;
+
+    private long restGetTimeout = GET_REQUEST_WAIT_INTERVAL;
+
+    /**
+     * Default constructor.
+     */
+    public SoManager() {
+        restManager = new RestManager();
+    }
+
+    /**
+     * Create a service instance in SO.
+     *
+     * @param url the SO URL
+     * @param urlBase the base URL
+     * @param username user name on SO
+     * @param password password on SO
+     * @param request the request to issue to SO
+     * @return the SO Response object
+     */
+    public SoResponse createModuleInstance(final String url, final String urlBase, final String username,
+                    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);
+        Pair<Integer, String> httpResponse =
+                        restManager.post(url, username, password, createSimpleHeaders(), MEDIA_TYPE, requestJson);
+
+        // Process the response from SO
+        SoResponse response = waitForSoOperationCompletion(urlBase, username, password, url, httpResponse);
+        if (SO_RESPONSE_ERROR != response.getHttpResponseCode()) {
+            return response;
+        } else {
+            return 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);
+    }
+
+    /**
+     * 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 vfModuleInstanceId vfModule instance id to construct the request url (required in case of delete vf
+     *                           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));
+    }
+
+    /**
+     * This class handles an asynchronous request to SO as a thread.
+     */
+    private class AsyncSoRestCallThread implements Callable<SoResponse> {
+        final String requestId;
+        final WorkingMemory wm;
+        final String serviceInstanceId;
+        final String vnfInstanceId;
+        final String vfModuleInstanceId;
+        final SoRequest request;
+
+        /**
+         * 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 vfModuleInstanceId the vf module instance id (not null in case of delete vf module request)
+         * @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) {
+            this.requestId = requestId;
+            this.wm = wm;
+            this.serviceInstanceId = serviceInstanceId;
+            this.vnfInstanceId = vnfInstanceId;
+            this.vfModuleInstanceId = vfModuleInstanceId;
+            this.request = request;
+        }
+
+        /**
+         * Process the asynchronous SO request.
+         */
+        @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;
+            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
+                        + "/vfModules/" + vfModuleInstanceId;
+                NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, url, soJson);
+                httpResponse = restManager.delete(url, username, password, createSimpleHeaders(), MEDIA_TYPE, soJson);
+            } else {
+                return null;
+            }
+
+            // Process the response from SO
+            SoResponse response = waitForSoOperationCompletion(urlBase, username, password, url, httpResponse);
+
+            // Return the response to Drools in its working memory
+            SoResponseWrapper soWrapper = new SoResponseWrapper(response, requestId);
+            wm.insert(soWrapper);
+
+            return response;
+        }
+    }
+
+    /**
+     * Wait for the SO operation we have ordered to complete.
+     *
+     * @param urlBaseSo The base URL for SO
+     * @param username user name on SO
+     * @param password password on SO
+     * @param initialRequestUrl The URL of the initial HTTP request
+     * @param initialHttpResponse The initial HTTP message returned from SO
+     * @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) {
+        // Process the initial response from SO, the response to a post
+        SoResponse response = processSoResponse(initialRequestUrl, initialHttpResponse);
+        if (SO_RESPONSE_ERROR == response.getHttpResponseCode()) {
+            return response;
+        }
+
+        // The SO URL to use to get the status of orchestration requests
+        String urlGet = urlBaseSo + "/orchestrationRequests/v5/" + response.getRequestReferences().getRequestId();
+
+        // The HTTP status code of the latest response
+        Pair<Integer, String> latestHttpResponse = initialHttpResponse;
+
+        // Wait for the response from SO
+        for (int attemptsLeft = GET_REQUESTS_BEFORE_TIMEOUT; attemptsLeft >= 0; attemptsLeft--) {
+            // The SO request may have completed even on the first request so we check the
+            // response
+            // here before
+            // issuing any other requests
+            if (isRequestStateFinished(latestHttpResponse, response)) {
+                return response;
+            }
+
+            // Wait for the defined interval before issuing a get
+            try {
+                Thread.sleep(restGetTimeout);
+            } catch (InterruptedException e) {
+                logger.error("Interrupted exception: ", e);
+                Thread.currentThread().interrupt();
+                response.setHttpResponseCode(SO_RESPONSE_ERROR);
+                return response;
+            }
+
+            // Issue a GET to find the current status of our request
+            NetLoggerUtil.getNetworkLogger().info("[OUT|{}|{}|{}|{}|{}|{}|]{}", "SO", urlGet, username, password,
+                            createSimpleHeaders(), MEDIA_TYPE, LINE_SEPARATOR);
+            Pair<Integer, String> httpResponse = restManager.get(urlGet, username, password, createSimpleHeaders());
+
+            // Get our response
+            response = processSoResponse(urlGet, httpResponse);
+            if (SO_RESPONSE_ERROR == response.getHttpResponseCode()) {
+                return response;
+            }
+
+            // Our latest HTTP response code
+            latestHttpResponse = httpResponse;
+        }
+
+        // We have timed out on the SO request
+        response.setHttpResponseCode(SO_RESPONSE_ERROR);
+        return response;
+    }
+
+    /**
+     * Parse the response message from SO into a SOResponse object.
+     *
+     * @param requestURL The URL of the HTTP request
+     * @param httpResponse The HTTP message returned from SO
+     * @return The parsed response
+     */
+    private SoResponse processSoResponse(final String requestUrl, final Pair<Integer, String> httpResponse) {
+        SoResponse response = new SoResponse();
+
+        // 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)) {
+            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);
+        } catch (JsonSyntaxException e) {
+            logger.error("Failed to deserialize HTTP response into SOResponse: ", e);
+            response.setHttpResponseCode(SO_RESPONSE_ERROR);
+            return response;
+        }
+
+        // Set the HTTP response code of the response if needed
+        if (response.getHttpResponseCode() == 0) {
+            response.setHttpResponseCode(httpResponse.first);
+        }
+
+        NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, requestUrl, httpResponse.second);
+
+        if (logger.isDebugEnabled()) {
+            logger.debug("***** Response to SO Request to URL {}:", requestUrl);
+            logger.debug(httpResponse.second);
+        }
+
+        return response;
+    }
+
+    /**
+     * Method to allow tuning of REST get timeout.
+     *
+     * @param restGetTimeout the timeout value
+     */
+    protected void setRestGetTimeout(final long restGetTimeout) {
+        this.restGetTimeout = restGetTimeout;
+    }
+
+    /**
+     * Check that the request state of a response is defined.
+     *
+     * @param response The response to check
+     * @return true if the request for the response is defined
+     */
+    private boolean isRequestStateDefined(final SoResponse response) {
+        return response != null && response.getRequest() != null && response.getRequest().getRequestStatus() != null
+                        && response.getRequest().getRequestStatus().getRequestState() != null;
+    }
+
+    /**
+     * Check that the request state of a response is finished.
+     *
+     * @param latestHttpDetails the HTTP details of the response
+     * @param response The response to check
+     * @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)) {
+            String requestState = response.getRequest().getRequestStatus().getRequestState();
+            return "COMPLETE".equalsIgnoreCase(requestState) || "FAILED".equalsIgnoreCase(requestState);
+        } else {
+            return false;
+        }
+    }
+
+    /**
+     * Check that a HTTP operation result has no nulls.
+     *
+     * @param httpOperationResult the result to check
+     * @return true if no nulls are found
+     */
+    private boolean httpResultIsNullFree(Pair<Integer, String> httpOperationResult) {
+        return httpOperationResult != null && httpOperationResult.first != null && httpOperationResult.second != null;
+    }
+
+    /**
+     * Create simple HTTP headers for unauthenticated requests to SO.
+     *
+     * @return the HTTP headers
+     */
+    private Map<String, String> createSimpleHeaders() {
+        Map<String, String> headers = new HashMap<>();
+        headers.put("Accept", MEDIA_TYPE);
+        return headers;
+    }
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoModelInfo.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoModelInfo.java
new file mode 100644
index 000000000..42e477b6b
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoModelInfo.java
@@ -0,0 +1,113 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoModelInfo implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("modelType")
+    private String modelType;
+
+    @SerializedName("modelInvariantId")
+    private String modelInvariantId;
+
+    @SerializedName("modelVersionId")
+    private String modelVersionId;
+
+    @SerializedName("modelName")
+    private String modelName;
+
+    @SerializedName("modelVersion")
+    private String modelVersion;
+
+    @SerializedName("modelCustomizationName")
+    private String modelCustomizationName;
+
+    @SerializedName("modelCustomizationId")
+    private String modelCustomizationId;
+
+    public SoModelInfo() {
+      //required by author
+    }
+
+    public String getModelCustomizationId() {
+        return modelCustomizationId;
+    }
+
+    public String getModelCustomizationName() {
+        return modelCustomizationName;
+    }
+
+    public String getModelInvariantId() {
+        return modelInvariantId;
+    }
+
+    public String getModelName() {
+        return modelName;
+    }
+
+    public String getModelType() {
+        return modelType;
+    }
+
+    public String getModelVersion() {
+        return modelVersion;
+    }
+
+    public String getModelVersionId() {
+        return modelVersionId;
+    }
+
+    public void setModelCustomizationId(String modelCustomizationId) {
+        this.modelCustomizationId = modelCustomizationId;
+    }
+
+    public void setModelCustomizationName(String modelCustomizationName) {
+        this.modelCustomizationName = modelCustomizationName;
+    }
+
+    public void setModelInvariantId(String modelInvariantId) {
+        this.modelInvariantId = modelInvariantId;
+    }
+
+    public void setModelName(String modelName) {
+        this.modelName = modelName;
+    }
+
+    public void setModelType(String modelType) {
+        this.modelType = modelType;
+    }
+
+    public void setModelVersion(String modelVersion) {
+        this.modelVersion = modelVersion;
+    }
+
+    public void setModelVersionId(String modelVersionId) {
+        this.modelVersionId = modelVersionId;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java
new file mode 100644
index 000000000..e2a7af71d
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoOperationType.java
@@ -0,0 +1,42 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2018 Amdocs. All rights reserved.
+ * Modifications Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+/**
+ * Enumeration of SO Operations type that can be performed by a policy.
+ */
+public enum SoOperationType {
+    SCALE_OUT("Create Vf Module"),
+    DELETE_VF_MODULE("Delete Vf Module");
+
+    private String operationType;
+
+    SoOperationType(String operationType) {
+        this.operationType = operationType;
+    }
+
+    @Override
+    public String toString() {
+        return this.operationType;
+    }
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoPolicyExceptionHolder.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoPolicyExceptionHolder.java
new file mode 100644
index 000000000..1b80898cc
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoPolicyExceptionHolder.java
@@ -0,0 +1,58 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoPolicyExceptionHolder implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("messageId")
+    private String messageId;
+
+    @SerializedName("text")
+    private String text;
+
+    public SoPolicyExceptionHolder() {
+      //required by author
+    }
+
+    public String getMessageId() {
+        return messageId;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public void setMessageId(String messageId) {
+        this.messageId = messageId;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRelatedInstance.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRelatedInstance.java
new file mode 100644
index 000000000..b55ce27e8
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRelatedInstance.java
@@ -0,0 +1,71 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoRelatedInstance implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("instanceId")
+    private String instanceId;
+
+    @SerializedName("instanceName")
+    private String instanceName;
+
+    @SerializedName("modelInfo")
+    private SoModelInfo modelInfo;
+
+    public SoRelatedInstance() {
+      //required by author
+    }
+
+    public String getInstanceId() {
+        return instanceId;
+    }
+
+
+    public String getInstanceName() {
+        return instanceName;
+    }
+
+    public SoModelInfo getModelInfo() {
+        return modelInfo;
+    }
+
+    public void setInstanceId(String instanceId) {
+        this.instanceId = instanceId;
+    }
+
+    public void setInstanceName(String instanceName) {
+        this.instanceName = instanceName;
+    }
+
+
+    public void setModelInfo(SoModelInfo modelInfo) {
+        this.modelInfo = modelInfo;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRelatedInstanceListElement.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRelatedInstanceListElement.java
new file mode 100644
index 000000000..7fa2d638f
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRelatedInstanceListElement.java
@@ -0,0 +1,47 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoRelatedInstanceListElement implements Serializable {
+ 
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("relatedInstance")
+    private SoRelatedInstance relatedInstance;
+
+    public SoRelatedInstanceListElement() {
+      //required by author
+    }
+
+    public SoRelatedInstance getRelatedInstance() {
+        return relatedInstance;
+    }
+
+    public void setRelatedInstance(SoRelatedInstance relatedInstance) {
+        this.relatedInstance = relatedInstance;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequest.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequest.java
new file mode 100644
index 000000000..9c4cc0f81
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequest.java
@@ -0,0 +1,124 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+import java.time.LocalDateTime;
+import java.util.UUID;
+
+public class SoRequest implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("requestId")
+    private UUID requestId;
+
+    @SerializedName("startTime")
+    private String startTime;
+
+    @SerializedName("finishTime")
+    private LocalDateTime finishTime;
+
+    @SerializedName("requestScope")
+    private String requestScope;
+
+    @SerializedName("requestType")
+    private String requestType;
+
+    @SerializedName("requestDetails")
+    private SoRequestDetails requestDetails;
+
+    @SerializedName("requestStatus")
+    private SoRequestStatus requestStatus;
+
+    private transient SoOperationType operationType;
+
+    public SoRequest() {
+        // required by author
+    }
+
+    public LocalDateTime getFinishTime() {
+        return finishTime;
+    }
+
+    public SoRequestDetails getRequestDetails() {
+        return requestDetails;
+    }
+
+    public UUID getRequestId() {
+        return requestId;
+    }
+
+    public String getRequestScope() {
+        return requestScope;
+    }
+
+    public SoRequestStatus getRequestStatus() {
+        return requestStatus;
+    }
+
+    public String getRequestType() {
+        return requestType;
+    }
+
+    public String getStartTime() {
+        return startTime;
+    }
+
+    public void setFinishTime(LocalDateTime finishTime) {
+        this.finishTime = finishTime;
+    }
+
+    public void setRequestDetails(SoRequestDetails requestDetails) {
+        this.requestDetails = requestDetails;
+    }
+
+    public void setRequestId(UUID requestId) {
+        this.requestId = requestId;
+    }
+
+    public void setRequestScope(String requestScope) {
+        this.requestScope = requestScope;
+    }
+
+    public void setRequestStatus(SoRequestStatus requestStatus) {
+        this.requestStatus = requestStatus;
+    }
+
+    public void setRequestType(String requestType) {
+        this.requestType = requestType;
+    }
+
+    public void setStartTime(String startTime) {
+        this.startTime = startTime;
+    }
+
+    public SoOperationType getOperationType() {
+        return operationType;
+    }
+
+    public void setOperationType(SoOperationType operationType) {
+        this.operationType = operationType;
+    }
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestDetails.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestDetails.java
new file mode 100644
index 000000000..b0f4ca7c3
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestDetails.java
@@ -0,0 +1,216 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+public class SoRequestDetails implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("modelInfo")
+    private SoModelInfo modelInfo;
+
+    @SerializedName("cloudConfiguration")
+    private SoCloudConfiguration cloudConfiguration;
+
+    @SerializedName("requestInfo")
+    private SoRequestInfo requestInfo;
+
+    @SerializedName("subscriberInfo")
+    private SoSubscriberInfo subscriberInfo;
+
+    @SerializedName("relatedInstanceList")
+    private List<SoRelatedInstanceListElement> relatedInstanceList = new LinkedList<>();
+
+    @SerializedName("requestParameters")
+    private SoRequestParameters requestParameters;
+
+    @SerializedName("configurationParameters")
+    private List<Map<String, String>> configurationParameters = new LinkedList<>();
+
+    public SoRequestDetails() {
+
+    }
+
+    /**
+     * Constructor.
+     * 
+     * @param soRequestDetails copy object
+     */
+    public SoRequestDetails(SoRequestDetails soRequestDetails) {
+        this.modelInfo = soRequestDetails.modelInfo;
+        this.cloudConfiguration = soRequestDetails.cloudConfiguration;
+        this.requestInfo = soRequestDetails.requestInfo;
+        this.relatedInstanceList = soRequestDetails.relatedInstanceList;
+        this.requestParameters = soRequestDetails.requestParameters;
+        this.subscriberInfo = soRequestDetails.subscriberInfo;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        SoRequestDetails other = (SoRequestDetails) obj;
+        if (cloudConfiguration == null) {
+            if (other.cloudConfiguration != null) {
+                return false;
+            }
+        } else if (!cloudConfiguration.equals(other.cloudConfiguration)) {
+            return false;
+        }
+        if (configurationParameters == null) {
+            if (other.configurationParameters != null) {
+                return false;
+            }
+        } else if (!configurationParameters.equals(other.configurationParameters)) {
+            return false;
+        }
+        if (modelInfo == null) {
+            if (other.modelInfo != null) {
+                return false;
+            }
+        } else if (!modelInfo.equals(other.modelInfo)) {
+            return false;
+        }
+        if (relatedInstanceList == null) {
+            if (other.relatedInstanceList != null) {
+                return false;
+            }
+        } else if (!relatedInstanceList.equals(other.relatedInstanceList)) {
+            return false;
+        }
+        if (requestInfo == null) {
+            if (other.requestInfo != null) {
+                return false;
+            }
+        } else if (!requestInfo.equals(other.requestInfo)) {
+            return false;
+        }
+        if (requestParameters == null) {
+            if (other.requestParameters != null) {
+                return false;
+            }
+        } else if (!requestParameters.equals(other.requestParameters)) {
+            return false;
+        }
+        if (subscriberInfo == null) {
+            if (other.subscriberInfo != null) {
+                return false;
+            }
+        } else if (!subscriberInfo.equals(other.subscriberInfo)) {
+            return false;
+        }
+        return true;
+    }
+
+    public SoCloudConfiguration getCloudConfiguration() {
+        return cloudConfiguration;
+    }
+
+    public SoModelInfo getModelInfo() {
+        return modelInfo;
+    }
+
+    public List<SoRelatedInstanceListElement> getRelatedInstanceList() {
+        return relatedInstanceList;
+    }
+
+    public SoRequestInfo getRequestInfo() {
+        return requestInfo;
+    }
+
+    public SoRequestParameters getRequestParameters() {
+        return requestParameters;
+    }
+
+    public List<Map<String, String>> getConfigurationParameters() {
+        return configurationParameters;
+    }
+
+    public SoSubscriberInfo getSubscriberInfo() {
+        return subscriberInfo;
+    }
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = 1;
+        result = prime * result + ((cloudConfiguration == null) ? 0 : cloudConfiguration.hashCode());
+        result = prime * result + ((configurationParameters == null) ? 0 : configurationParameters.hashCode());
+        result = prime * result + ((modelInfo == null) ? 0 : modelInfo.hashCode());
+        result = prime * result + ((relatedInstanceList == null) ? 0 : relatedInstanceList.hashCode());
+        result = prime * result + ((requestInfo == null) ? 0 : requestInfo.hashCode());
+        result = prime * result + ((requestParameters == null) ? 0 : requestParameters.hashCode());
+        result = prime * result + ((subscriberInfo == null) ? 0 : subscriberInfo.hashCode());
+        return result;
+    }
+
+    public void setCloudConfiguration(SoCloudConfiguration cloudConfiguration) {
+        this.cloudConfiguration = cloudConfiguration;
+    }
+
+    public void setModelInfo(SoModelInfo modelInfo) {
+        this.modelInfo = modelInfo;
+    }
+
+    public void setRequestInfo(SoRequestInfo requestInfo) {
+        this.requestInfo = requestInfo;
+    }
+
+    public void setRequestParameters(SoRequestParameters requestParameters) {
+        this.requestParameters = requestParameters;
+    }
+
+    public void setConfigurationParameters(List<Map<String, String>> configurationParameters) {
+        this.configurationParameters = configurationParameters;
+    }
+
+    public void setSubscriberInfo(SoSubscriberInfo subscriberInfo) {
+        this.subscriberInfo = subscriberInfo;
+    }
+
+    public void setRelatedInstanceList(List<SoRelatedInstanceListElement> relatedInstanceList) {
+        this.relatedInstanceList = relatedInstanceList;
+    }
+
+    @Override
+    public String toString() {
+        return "SORequestDetails [modelInfo=" + modelInfo + ", cloudConfiguration=" + cloudConfiguration
+                        + ", requestInfo=" + requestInfo + ", subscriberInfo=" + subscriberInfo
+                        + ", relatedInstanceList=" + relatedInstanceList + ", requestParameters=" + requestParameters
+                        + ", configurationParameters=" + configurationParameters + "]";
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestError.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestError.java
new file mode 100644
index 000000000..06dea0549
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestError.java
@@ -0,0 +1,58 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoRequestError implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("policyException")
+    private SoPolicyExceptionHolder policyException;
+
+    @SerializedName("serviceException")
+    private SoServiceExceptionHolder serviceException;
+
+    public SoRequestError() {
+        // required by author
+    }
+
+    public SoPolicyExceptionHolder getPolicyException() {
+        return policyException;
+    }
+
+    public SoServiceExceptionHolder getServiceException() {
+        return serviceException;
+    }
+
+    public void setPolicyException(SoPolicyExceptionHolder policyException) {
+        this.policyException = policyException;
+    }
+
+    public void setServiceException(SoServiceExceptionHolder serviceException) {
+        this.serviceException = serviceException;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestInfo.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestInfo.java
new file mode 100644
index 000000000..06f456a8d
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestInfo.java
@@ -0,0 +1,146 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoRequestInfo implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("instanceName")
+    private String instanceName;
+
+    @SerializedName("source")
+    private String source;
+
+    @SerializedName("productFamilyId")
+    private String productFamilyId;
+
+    @SerializedName("suppressRollback")
+    private boolean suppressRollback;
+
+    @SerializedName("billingAccountNumber")
+    private String billingAccountNumber;
+
+    @SerializedName("callbackUrl")
+    private String callbackUrl;
+
+    @SerializedName("correlator")
+    private String correlator;
+
+    @SerializedName("orderNumber")
+    private String orderNumber;
+
+    @SerializedName("orderVersion")
+    private Integer orderVersion;
+
+    @SerializedName("requestorId")
+    private String requestorId;
+
+    public SoRequestInfo() {
+        // required by author
+    }
+
+    public String getBillingAccountNumber() {
+        return billingAccountNumber;
+    }
+
+    public String getCallbackUrl() {
+        return callbackUrl;
+    }
+
+    public String getCorrelator() {
+        return correlator;
+    }
+
+    public String getInstanceName() {
+        return instanceName;
+    }
+
+    public String getOrderNumber() {
+        return orderNumber;
+    }
+
+    public Integer getOrderVersion() {
+        return orderVersion;
+    }
+
+    public String getProductFamilyId() {
+        return productFamilyId;
+    }
+
+    public String getRequestorId() {
+        return requestorId;
+    }
+
+    public String getSource() {
+        return source;
+    }
+
+    public boolean isSuppressRollback() {
+        return suppressRollback;
+    }
+
+    public void setBillingAccountNumber(String billingAccountNumber) {
+        this.billingAccountNumber = billingAccountNumber;
+    }
+
+    public void setCallbackUrl(String callbackUrl) {
+        this.callbackUrl = callbackUrl;
+    }
+
+    public void setCorrelator(String correlator) {
+        this.correlator = correlator;
+    }
+
+    public void setInstanceName(String instanceName) {
+        this.instanceName = instanceName;
+    }
+
+    public void setOrderNumber(String orderNumber) {
+        this.orderNumber = orderNumber;
+    }
+
+    public void setOrderVersion(Integer orderVersion) {
+        this.orderVersion = orderVersion;
+    }
+
+    public void setProductFamilyId(String productFamilyId) {
+        this.productFamilyId = productFamilyId;
+    }
+
+    public void setRequestorId(String requestorId) {
+        this.requestorId = requestorId;
+    }
+
+    public void setSource(String source) {
+        this.source = source;
+    }
+
+    public void setSuppressRollback(boolean suppressRollback) {
+        this.suppressRollback = suppressRollback;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestParameters.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestParameters.java
new file mode 100644
index 000000000..2db4e1a03
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestParameters.java
@@ -0,0 +1,72 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+public class SoRequestParameters implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236033L;
+
+    @SerializedName("subscriptionServiceType")
+    private String subscriptionServiceType;
+
+    @SerializedName("usePreload")
+    private boolean usePreload;
+
+    @SerializedName("userParams")
+    private List<Map<String, String>> userParams = new LinkedList<>();
+
+    public SoRequestParameters() {
+        // required by author
+    }
+
+    public String getSubscriptionServiceType() {
+        return subscriptionServiceType;
+    }
+
+    public boolean isUsePreload() {
+        return usePreload;
+    }
+
+    public List<Map<String, String>> getUserParams() {
+        return userParams;
+    }
+
+    public void setSubscriptionServiceType(String subscriptionServiceType) {
+        this.subscriptionServiceType = subscriptionServiceType;
+    }
+
+    public void setUsePreload(boolean usePreload) {
+        this.usePreload = usePreload;
+    }
+
+    public void setUserParams(List<Map<String, String>> userParams) {
+        this.userParams = userParams;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestReferences.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestReferences.java
new file mode 100644
index 000000000..92ec1fe2e
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestReferences.java
@@ -0,0 +1,54 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoRequestReferences implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("instanceId")
+    private String instanceId;
+
+    @SerializedName("requestId")
+    private String requestId;
+
+    public String getInstanceId() {
+        return instanceId;
+    }
+
+    public String getRequestId() {
+        return requestId;
+    }
+
+    public void setInstanceId(String instanceId) {
+        this.instanceId = instanceId;
+    }
+
+    public void setRequestId(String requestId) {
+        this.requestId = requestId;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestStatus.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestStatus.java
new file mode 100644
index 000000000..95df506f9
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoRequestStatus.java
@@ -0,0 +1,80 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoRequestStatus implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("percentProgress")
+    private int percentProgress;
+
+    @SerializedName("requestState")
+    private String requestState;
+
+    @SerializedName("timestamp")
+    private String timestamp;
+
+    @SerializedName("wasRolledBack")
+    private boolean wasRolledBack;
+
+    public SoRequestStatus() {
+      //required by author
+    }
+
+    public int getPercentProgress() {
+        return percentProgress;
+    }
+
+    public String getRequestState() {
+        return requestState;
+    }
+
+    public String getTimestamp() {
+        return timestamp;
+    }
+
+    public boolean isWasRolledBack() {
+        return wasRolledBack;
+    }
+
+    public void setPercentProgress(int percentProgress) {
+        this.percentProgress = percentProgress;
+    }
+
+    public void setRequestState(String requestState) {
+        this.requestState = requestState;
+    }
+
+    public void setTimestamp(String timestamp) {
+        this.timestamp = timestamp;
+    }
+
+    public void setWasRolledBack(boolean wasRolledBack) {
+        this.wasRolledBack = wasRolledBack;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoResponse.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoResponse.java
new file mode 100644
index 000000000..5feeb415e
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoResponse.java
@@ -0,0 +1,79 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoResponse implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("requestReferences")
+    private SoRequestReferences requestReferences;
+
+    @SerializedName("requestError")
+    private SoRequestError requestError;
+
+    @SerializedName("request")
+    private SoRequest request;
+
+    private int httpResponseCode;
+
+    public SoResponse() {
+        // required by author
+    }
+
+    public int getHttpResponseCode() {
+        return httpResponseCode;
+    }
+
+    public SoRequest getRequest() {
+        return request;
+    }
+
+    public SoRequestError getRequestError() {
+        return requestError;
+    }
+
+    public SoRequestReferences getRequestReferences() {
+        return requestReferences;
+    }
+
+    public void setHttpResponseCode(int httpResponseCode) {
+        this.httpResponseCode = httpResponseCode;
+    }
+
+    public void setRequest(SoRequest request) {
+        this.request = request;
+    }
+
+    public void setRequestError(SoRequestError requestError) {
+        this.requestError = requestError;
+    }
+
+    public void setRequestReferences(SoRequestReferences requestReferences) {
+        this.requestReferences = requestReferences;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoResponseWrapper.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoResponseWrapper.java
new file mode 100644
index 000000000..2a74f38b5
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoResponseWrapper.java
@@ -0,0 +1,103 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoResponseWrapper implements Serializable {
+
+    private static final long serialVersionUID = 7673023687132889069L;
+
+    @SerializedName("SoResponse")
+    private SoResponse soResponse;
+
+    private transient String requestId;
+
+    public SoResponseWrapper(SoResponse response, String reqId) {
+        this.soResponse = response;
+        this.requestId = reqId;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+        if (obj == null) {
+            return false;
+        }
+        if (getClass() != obj.getClass()) {
+            return false;
+        }
+        SoResponseWrapper other = (SoResponseWrapper) obj;
+        if (soResponse == null) {
+            if (other.soResponse != null) {
+                return false;
+            }
+        }
+        else if (!soResponse.equals(other.soResponse)) {
+            return false;
+        }
+        if (requestId == null) {
+            if (other.requestId != null) {
+                return false;
+            }
+        }
+        else if (!requestId.equals(other.requestId)) {
+            return false;
+        }
+        return true;
+    }
+
+    public String getRequestId() {
+        return requestId;
+    }
+
+    public SoResponse getSoResponse() {
+        return soResponse;
+    }
+
+    @Override
+    public int hashCode() {
+        final int prime = 31;
+        int result = super.hashCode();
+        result = prime * result + ((soResponse == null) ? 0 : soResponse.hashCode());
+        result = prime * result + ((requestId == null) ? 0 : requestId.hashCode());
+        return result;
+    }
+
+    public void setRequestId(String requestId) {
+        this.requestId = requestId;
+    }
+
+    public void setSoResponse(SoResponse response) {
+        soResponse = response;
+    }
+
+    @Override
+    public String toString() {
+        return "SOResponseWrapper [SOResponse=" + soResponse + ", RequestId=" + requestId + "]";
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoServiceExceptionHolder.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoServiceExceptionHolder.java
new file mode 100644
index 000000000..79c162b4e
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoServiceExceptionHolder.java
@@ -0,0 +1,67 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+import java.util.LinkedList;
+import java.util.List;
+
+public class SoServiceExceptionHolder implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("messageId")
+    private String messageId;
+
+    @SerializedName("text")
+    private String text;
+
+    @SerializedName("variables")
+    private List<String> variables = new LinkedList<>();
+
+    public SoServiceExceptionHolder() {
+        // required by author
+    }
+
+    public String getMessageId() {
+        return messageId;
+    }
+
+    public String getText() {
+        return text;
+    }
+
+    public List<String> getVariables() {
+        return variables;
+    }
+
+    public void setMessageId(String messageId) {
+        this.messageId = messageId;
+    }
+
+    public void setText(String text) {
+        this.text = text;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoSubscriberInfo.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoSubscriberInfo.java
new file mode 100644
index 000000000..19f279dbb
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/SoSubscriberInfo.java
@@ -0,0 +1,69 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * so
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.io.Serializable;
+
+public class SoSubscriberInfo implements Serializable {
+
+    private static final long serialVersionUID = -3283942659786236032L;
+
+    @SerializedName("globalSubscriberId")
+    private String globalSubscriberId;
+
+    @SerializedName("subscriberCommonSiteId")
+    private String subscriberCommonSiteId;
+
+    @SerializedName("subscriberName")
+    private String subscriberName;
+
+    public SoSubscriberInfo() {
+        //required by author
+    }
+
+    public String getGlobalSubscriberId() {
+        return globalSubscriberId;
+    }
+
+    public String getSubscriberCommonSiteId() {
+        return subscriberCommonSiteId;
+    }
+
+    public String getSubscriberName() {
+        return subscriberName;
+    }
+
+    public void setGlobalSubscriberId(String globalSubscriberId) {
+        this.globalSubscriberId = globalSubscriberId;
+    }
+
+    public void setSubscriberCommonSiteId(String subscriberCommonSiteId) {
+        this.subscriberCommonSiteId = subscriberCommonSiteId;
+    }
+
+    public void setSubscriberName(String subscriberName) {
+        this.subscriberName = subscriberName;
+    }
+
+}
diff --git a/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/util/Serialization.java b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/util/Serialization.java
new file mode 100644
index 000000000..b23ccc993
--- /dev/null
+++ b/models-interactions/model-impl/so/src/main/java/org/onap/policy/so/util/Serialization.java
@@ -0,0 +1,36 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * mso
+ * ================================================================================
+ * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2019 Nordix Foundation.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.so.util;
+
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+
+public final class Serialization {
+
+    public static final Gson gsonPretty =
+            new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create();
+
+    private Serialization() {
+        // utility class with explicit private constructor
+        // change if class is more than utility
+    }
+}