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.changeManagement.WorkflowRequestDetail;
  26 import org.onap.vid.mso.rest.RequestDetails;
  27
  28 import java.util.Map;
  29
  30 /**
  31  * Created by pickjonathan on 21/06/2017.
  32  */
  33 public interface MsoInterface {
  34
  35     /**
  36      * This function will post MSO service with information about how to instantiate the requested service
  37      * @param requestDetails The details about the service as they come from the web.
  38      * @return MsoResponseWrapper containing information about the service instantiation
  39      * --> success : see JSON at resources folder mso_create_instance_response.
  40      * --> failure : would return 200 with failure data.
  41      * @throws Exception
  42      */
  43     MsoResponseWrapper createSvcInstance(RequestDetails requestDetails, String endpoint);
  44
  45     //For VoLTE E2E services
  46     MsoResponseWrapper createE2eSvcInstance(Object requestDetails, String endpoint);
  47     MsoResponseWrapper deleteE2eSvcInstance(Object requestDetails, String endpoint);
  48
  49     /**
  50      * will create a virtual network function using MSO service.
  51      * @param requestDetails - information about the vnf to create
  52      * @return - the response body recived from MSO
  53      * @throws Exception
  54      */
  55     MsoResponseWrapper createVnf(RequestDetails requestDetails, String endpoint);
  56
  57     MsoResponseWrapper createNwInstance(RequestDetails requestDetails, String endpoint);
  58     /**
  59      *
  60      * @param requestDetails
  61      * @param path
  62      * @return
  63      * @throws Exception
  64      */
  65     MsoResponseWrapper createVolumeGroupInstance(RequestDetails requestDetails, String path);
  66
  67     /**
  68      *
  69      * @param requestDetails
  70      * @return
  71      * @throws Exception
  72      */
  73     MsoResponseWrapper createVfModuleInstance(RequestDetails requestDetails, String endpoint);
  74
  75     MsoResponseWrapper createConfigurationInstance(org.onap.vid.mso.rest.RequestDetailsWrapper requestDetailsWrapper, String endpoint);
  76
  77     MsoResponseWrapper scaleOutVFModuleInstance(RequestDetailsWrapper requestDetailsWrapper, String endpoint);
  78
  79     MsoResponseWrapper deleteSvcInstance(RequestDetails requestDetails, String endpoint);
  80
  81     MsoResponseWrapper unassignSvcInstance(RequestDetails requestDetails, String endpoint);
  82
  83     MsoResponseWrapper deleteVnf(RequestDetails requestDetails, String endpoint);
  84
  85     MsoResponseWrapper deleteVfModule(RequestDetails requestDetails, String endpoint);
  86
  87     MsoResponseWrapper deleteVolumeGroupInstance(RequestDetails requestDetails, String endpoint);
  88
  89     MsoResponseWrapper deleteNwInstance(RequestDetails requestDetails, String endpoint);
  90
  91     MsoResponseWrapper getOrchestrationRequest(String t, String sourceId, String endpoint, RestObject restObject, boolean warpException);
  92
  93     MsoResponseWrapper getOrchestrationRequest(String endpoint);
  94
  95     MsoResponseWrapper getManualTasksByRequestId(String t , String sourceId , String endpoint , RestObject restObject);
  96
  97     MsoResponseWrapper completeManualTask(RequestDetails requestDetails, String t, String sourceId, String endpoint, RestObject restObject);
  98
  99         MsoResponseWrapper updateVnf(org.onap.vid.changeManagement.RequestDetails requestDetails, String vnfEndpoint);
 100
 101         MsoResponseWrapper replaceVnf(org.onap.vid.changeManagement.RequestDetails requestDetails, String vnfEndpoint);
 102
 103     MsoResponseWrapper deleteConfiguration(org.onap.vid.mso.rest.RequestDetailsWrapper requestDetailsWrapper, String pmcEndpoint);
 104
 105     MsoResponseWrapper setConfigurationActiveStatus(RequestDetails requestDetails, String endpoint);
 106
 107     MsoResponseWrapper setPortOnConfigurationStatus(RequestDetails requestDetails, String endpoint);
 108
 109     void setServiceInstanceStatus(RequestDetails requestDetails, String t, String sourceId, String endpoint, RestObject<String> restObject);
 110
 111     MsoResponseWrapperInterface changeManagementUpdate(RequestDetailsWrapper requestDetails, String endpoint);
 112
 113     MsoResponseWrapper removeRelationshipFromServiceInstance(RequestDetails requestDetails, String endpoint);
 114
 115     MsoResponseWrapper addRelationshipToServiceInstance(RequestDetails requestDetails, String addRelationshipsPath);
 116
 117     MsoResponseWrapper invokeWorkflow(WorkflowRequestDetail requestDetails,String invokeWorkflowsPath,  Map<String, String> extraHeaders);
 118
 119     <T> HttpResponse<T> get(String path, Class<T> responseClass);
 120
 121     <T> HttpResponse<T> post(String path, RequestDetailsWrapper<?> requestDetailsWrapper,
 122       Class<T> responseClass);
 123 }
 124