vid-app-common/src/main/java/org/onap/vid/mso/MsoInterface.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * VID
   4  * ================================================================================
   5  * Copyright (C) 2017 - 2019 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2018 - 2019 Nokia. All rights reserved.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.vid.mso;
  22
  23 import io.joshworks.restclient.http.HttpResponse;
  24 import org.onap.vid.changeManagement.RequestDetailsWrapper;
  25 import org.onap.vid.model.SOWorkflowList;
  26 import org.onap.vid.changeManagement.WorkflowRequestDetail;
  27 import org.onap.vid.mso.rest.RequestDetails;
  28
  29 import java.util.Map;
  30
  31 /**
  32  * Created by pickjonathan on 21/06/2017.
  33  */
  34 public interface MsoInterface {
  35
  36     /**
  37      * This function will post MSO service with information about how to instantiate the requested service
  38      * @param requestDetails The details about the service as they come from the web.
  39      * @return MsoResponseWrapper containing information about the service instantiation
  40      * --> success : see JSON at resources folder mso_create_instance_response.
  41      * --> failure : would return 200 with failure data.
  42      * @throws Exception
  43      */
  44     MsoResponseWrapper createSvcInstance(RequestDetails requestDetails, String endpoint);
  45
  46     //For VoLTE E2E services
  47     MsoResponseWrapper createE2eSvcInstance(Object requestDetails, String endpoint);
  48     MsoResponseWrapper deleteE2eSvcInstance(Object requestDetails, String endpoint);
  49
  50     /**
  51      * will create a virtual network function using MSO service.
  52      * @param requestDetails - information about the vnf to create
  53      * @return - the response body recived from MSO
  54      * @throws Exception
  55      */
  56     MsoResponseWrapper createVnf(RequestDetails requestDetails, String endpoint);
  57
  58     MsoResponseWrapper createNwInstance(RequestDetails requestDetails, String endpoint);
  59     /**
  60      *
  61      * @param requestDetails
  62      * @param path
  63      * @return
  64      * @throws Exception
  65      */
  66     MsoResponseWrapper createVolumeGroupInstance(RequestDetails requestDetails, String path);
  67
  68     /**
  69      *
  70      * @param requestDetails
  71      * @return
  72      * @throws Exception
  73      */
  74     MsoResponseWrapper createVfModuleInstance(RequestDetails requestDetails, String endpoint);
  75
  76     MsoResponseWrapper createConfigurationInstance(org.onap.vid.mso.rest.RequestDetailsWrapper requestDetailsWrapper, String endpoint);
  77
  78     MsoResponseWrapper scaleOutVFModuleInstance(RequestDetailsWrapper requestDetailsWrapper, String endpoint);
  79
  80     MsoResponseWrapper deleteSvcInstance(RequestDetails requestDetails, String endpoint);
  81
  82     MsoResponseWrapper unassignSvcInstance(RequestDetails requestDetails, String endpoint);
  83
  84     MsoResponseWrapper deleteVnf(RequestDetails requestDetails, String endpoint);
  85
  86     MsoResponseWrapper deleteVfModule(RequestDetails requestDetails, String endpoint);
  87
  88     MsoResponseWrapper deleteVolumeGroupInstance(RequestDetails requestDetails, String endpoint);
  89
  90     MsoResponseWrapper deleteNwInstance(RequestDetails requestDetails, String endpoint);
  91
  92     MsoResponseWrapper getOrchestrationRequest(String t, String sourceId, String endpoint, RestObject restObject, boolean warpException);
  93
  94     MsoResponseWrapper getOrchestrationRequest(String endpoint);
  95
  96     MsoResponseWrapper getManualTasksByRequestId(String t , String sourceId , String endpoint , RestObject restObject);
  97
  98     MsoResponseWrapper completeManualTask(RequestDetails requestDetails, String t, String sourceId, String endpoint, RestObject restObject);
  99
 100         MsoResponseWrapper updateVnf(org.onap.vid.changeManagement.RequestDetails requestDetails, String vnfEndpoint);
 101
 102         MsoResponseWrapper replaceVnf(org.onap.vid.changeManagement.RequestDetails requestDetails, String vnfEndpoint);
 103
 104     MsoResponseWrapper deleteConfiguration(org.onap.vid.mso.rest.RequestDetailsWrapper requestDetailsWrapper, String pmcEndpoint);
 105
 106     MsoResponseWrapper setConfigurationActiveStatus(RequestDetails requestDetails, String endpoint);
 107
 108     MsoResponseWrapper setPortOnConfigurationStatus(RequestDetails requestDetails, String endpoint);
 109
 110     void setServiceInstanceStatus(RequestDetails requestDetails, String t, String sourceId, String endpoint, RestObject<String> restObject);
 111
 112     MsoResponseWrapperInterface changeManagementUpdate(RequestDetailsWrapper requestDetails, String endpoint);
 113
 114     MsoResponseWrapper removeRelationshipFromServiceInstance(RequestDetails requestDetails, String endpoint);
 115
 116     MsoResponseWrapper addRelationshipToServiceInstance(RequestDetails requestDetails, String addRelationshipsPath);
 117
 118     HttpResponse<SOWorkflowList> getWorkflowListByModelId(String endpoint);
 119
 120     MsoResponseWrapper invokeWorkflow(WorkflowRequestDetail requestDetails,String invokeWorkflowsPath,  Map<String, String> extraHeaders);
 121
 122     <T> HttpResponse<T> get(String path, Class<T> responseClass);
 123
 124     <T> HttpResponse<T> post(String path, RequestDetailsWrapper<?> requestDetailsWrapper,
 125       Class<T> responseClass);
 126 }
 127