gerrit.onap Code Review - so.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP - SO
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.so.adapters.requestsdb;
  22
  23 import javax.jws.WebMethod;
  24 import javax.jws.WebParam;
  25 import javax.jws.WebService;
  26 import javax.xml.bind.annotation.XmlElement;
  27 import org.onap.so.adapters.requestsdb.exceptions.MsoRequestsDbException;
  28 import org.onap.so.db.request.beans.InfraActiveRequests;
  29 import org.onap.so.db.request.beans.InstanceNfvoMapping;
  30 import org.onap.so.db.request.beans.OperationStatus;
  31 import org.onap.so.db.request.beans.ResourceOperationStatus;
  32
  33 /**
  34  * MSO Request DB Adapter Web Service
  35  */
  36 @Deprecated
  37 @WebService(name = "RequestsDbAdapter", targetNamespace = "http://org.onap.so/requestsdb")
  38 public interface MsoRequestsDbAdapter {
  39
  40     @WebMethod
  41     public void updateInfraRequest(@WebParam(name = "requestId") @XmlElement(required = true) String requestId,
  42             @WebParam(name = "lastModifiedBy") @XmlElement(required = true) String lastModifiedBy,
  43             @WebParam(name = "statusMessage") @XmlElement(required = false) String statusMessage,
  44             @WebParam(name = "responseBody") @XmlElement(required = false) String responseBody,
  45             @WebParam(name = "requestStatus") @XmlElement(required = false) RequestStatusType requestStatus,
  46             @WebParam(name = "progress") @XmlElement(required = false) String progress,
  47             @WebParam(name = "vnfOutputs") @XmlElement(required = false) String vnfOutputs,
  48             @WebParam(name = "serviceInstanceId") @XmlElement(required = false) String serviceInstanceId,
  49             @WebParam(name = "networkId") @XmlElement(required = false) String networkId,
  50             @WebParam(name = "vnfId") @XmlElement(required = false) String vnfId,
  51             @WebParam(name = "vfModuleId") @XmlElement(required = false) String vfModuleId,
  52             @WebParam(name = "volumeGroupId") @XmlElement(required = false) String volumeGroupId,
  53             @WebParam(name = "serviceInstanceName") @XmlElement(required = false) String serviceInstanceName,
  54             @WebParam(name = "configurationId") @XmlElement(required = false) String configurationId,
  55             @WebParam(name = "configurationName") @XmlElement(required = false) String configurationName,
  56             @WebParam(name = "vfModuleName") @XmlElement(required = false) String vfModuleName)
  57             throws MsoRequestsDbException;
  58
  59     @WebMethod
  60     public void setInstanceNfvoMappingRepository(
  61             @WebParam(name = "instanceId") @XmlElement(required = true) String instanceId,
  62             @WebParam(name = "nfvoName") @XmlElement(required = true) String nfvoName,
  63             @WebParam(name = "endpoint") @XmlElement(required = true) String endpoint,
  64             @WebParam(name = "username") @XmlElement(required = true) String username,
  65             @WebParam(name = "password") @XmlElement(required = true) String password,
  66             @WebParam(name = "apiRoot") @XmlElement(required = false) String apiRoot) throws MsoRequestsDbException;
  67
  68     @WebMethod
  69     public InstanceNfvoMapping getInstanceNfvoMapping(
  70             @WebParam(name = "instanceId") @XmlElement(required = true) String instanceId)
  71             throws MsoRequestsDbException;
  72
  73     @WebMethod
  74     public InfraActiveRequests getInfraRequest(
  75             @WebParam(name = "requestId") @XmlElement(required = true) String requestId) throws MsoRequestsDbException;
  76
  77     @WebMethod
  78     public boolean getSiteStatus(@WebParam(name = "siteName") @XmlElement(required = true) String siteName);
  79
  80     @WebMethod
  81     public OperationStatus getServiceOperationStatus(
  82             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  83             @WebParam(name = "operationId") @XmlElement(required = false) String operationId)
  84             throws MsoRequestsDbException;
  85
  86     @WebMethod
  87     public void updateServiceOperationStatus(
  88             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  89             @WebParam(name = "operationId") @XmlElement(required = false) String operationId,
  90             @WebParam(name = "operationType") @XmlElement(required = false) String operationType,
  91             @WebParam(name = "userId") @XmlElement(required = false) String userId,
  92             @WebParam(name = "result") @XmlElement(required = false) String result,
  93             @WebParam(name = "operationContent") @XmlElement(required = false) String operationContent,
  94             @WebParam(name = "progress") @XmlElement(required = false) String progress,
  95             @WebParam(name = "reason") @XmlElement(required = false) String reason) throws MsoRequestsDbException;
  96
  97     @WebMethod
  98     public void initServiceOperationStatus(@WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  99             @WebParam(name = "operationId") @XmlElement(required = false) String operationId,
 100             @WebParam(name = "operationType") @XmlElement(required = false) String operationType,
 101             @WebParam(name = "userId") @XmlElement(required = false) String userId,
 102             @WebParam(name = "result") @XmlElement(required = false) String result,
 103             @WebParam(name = "operationContent") @XmlElement(required = false) String operationContent,
 104             @WebParam(name = "progress") @XmlElement(required = false) String progress,
 105             @WebParam(name = "reason") @XmlElement(required = false) String reason) throws MsoRequestsDbException;
 106
 107     @WebMethod
 108     public void initResourceOperationStatus(@WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
 109             @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
 110             @WebParam(name = "operationType") @XmlElement(required = true) String operationType,
 111             @WebParam(name = "resourceTemplateUUIDs") @XmlElement(required = true) String resourceTemplateUUIDs)
 112             throws MsoRequestsDbException;
 113
 114     @WebMethod
 115     public ResourceOperationStatus getResourceOperationStatus(
 116             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
 117             @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
 118             @WebParam(name = "resourceTemplateUUID") @XmlElement(required = true) String resourceTemplateUUID)
 119             throws MsoRequestsDbException;
 120
 121     @WebMethod
 122     public void updateResourceOperationStatus(
 123             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
 124             @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
 125             @WebParam(name = "resourceTemplateUUID") @XmlElement(required = true) String resourceTemplateUUID,
 126             @WebParam(name = "operType") @XmlElement(required = false) String operType,
 127             @WebParam(name = "resourceInstanceID") @XmlElement(required = false) String resourceInstanceID,
 128             @WebParam(name = "jobId") @XmlElement(required = false) String jobId,
 129             @WebParam(name = "status") @XmlElement(required = false) String status,
 130             @WebParam(name = "progress") @XmlElement(required = false) String progress,
 131             @WebParam(name = "errorCode") @XmlElement(required = false) String errorCode,
 132             @WebParam(name = "statusDescription") @XmlElement(required = false) String statusDescription)
 133             throws MsoRequestsDbException;
 134 }