adapters/mso-requests-db-adapter/src/main/java/org/onap/so/adapters/requestsdb/MsoRequestsDbAdapter.java

   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.ResourceOperationStatus;
  30
  31 /**
  32  * MSO Request DB Adapter Web Service
  33  */
  34 @WebService(name = "RequestsDbAdapter", targetNamespace = "http://org.onap.so/requestsdb")
  35 public interface MsoRequestsDbAdapter {
  36
  37     @WebMethod
  38     public void updateInfraRequest(@WebParam(name = "requestId") @XmlElement(required = true) String requestId,
  39             @WebParam(name = "lastModifiedBy") @XmlElement(required = true) String lastModifiedBy,
  40             @WebParam(name = "statusMessage") @XmlElement(required = false) String statusMessage,
  41             @WebParam(name = "responseBody") @XmlElement(required = false) String responseBody,
  42             @WebParam(name = "requestStatus") @XmlElement(required = false) RequestStatusType requestStatus,
  43             @WebParam(name = "progress") @XmlElement(required = false) String progress,
  44             @WebParam(name = "vnfOutputs") @XmlElement(required = false) String vnfOutputs,
  45             @WebParam(name = "serviceInstanceId") @XmlElement(required = false) String serviceInstanceId,
  46             @WebParam(name = "networkId") @XmlElement(required = false) String networkId,
  47             @WebParam(name = "vnfId") @XmlElement(required = false) String vnfId,
  48             @WebParam(name = "vfModuleId") @XmlElement(required = false) String vfModuleId,
  49             @WebParam(name = "volumeGroupId") @XmlElement(required = false) String volumeGroupId,
  50             @WebParam(name = "serviceInstanceName") @XmlElement(required = false) String serviceInstanceName,
  51             @WebParam(name = "configurationId") @XmlElement(required = false) String configurationId,
  52             @WebParam(name = "configurationName") @XmlElement(required = false) String configurationName,
  53             @WebParam(name = "vfModuleName") @XmlElement(required = false) String vfModuleName)
  54             throws MsoRequestsDbException;
  55
  56     @WebMethod
  57     public InfraActiveRequests getInfraRequest(
  58             @WebParam(name = "requestId") @XmlElement(required = true) String requestId) throws MsoRequestsDbException;
  59
  60     @WebMethod
  61     public boolean getSiteStatus(@WebParam(name = "siteName") @XmlElement(required = true) String siteName);
  62
  63     @WebMethod
  64     public void updateServiceOperationStatus(
  65             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  66             @WebParam(name = "operationId") @XmlElement(required = false) String operationId,
  67             @WebParam(name = "operationType") @XmlElement(required = false) String operationType,
  68             @WebParam(name = "userId") @XmlElement(required = false) String userId,
  69             @WebParam(name = "result") @XmlElement(required = false) String result,
  70             @WebParam(name = "operationContent") @XmlElement(required = false) String operationContent,
  71             @WebParam(name = "progress") @XmlElement(required = false) String progress,
  72             @WebParam(name = "reason") @XmlElement(required = false) String reason) throws MsoRequestsDbException;
  73
  74     @WebMethod
  75     public void initServiceOperationStatus(@WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  76             @WebParam(name = "operationId") @XmlElement(required = false) String operationId,
  77             @WebParam(name = "operationType") @XmlElement(required = false) String operationType,
  78             @WebParam(name = "userId") @XmlElement(required = false) String userId,
  79             @WebParam(name = "result") @XmlElement(required = false) String result,
  80             @WebParam(name = "operationContent") @XmlElement(required = false) String operationContent,
  81             @WebParam(name = "progress") @XmlElement(required = false) String progress,
  82             @WebParam(name = "reason") @XmlElement(required = false) String reason) throws MsoRequestsDbException;
  83
  84     @WebMethod
  85     public void initResourceOperationStatus(@WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  86             @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
  87             @WebParam(name = "operationType") @XmlElement(required = true) String operationType,
  88             @WebParam(name = "resourceTemplateUUIDs") @XmlElement(required = true) String resourceTemplateUUIDs)
  89             throws MsoRequestsDbException;
  90
  91     @WebMethod
  92     public ResourceOperationStatus getResourceOperationStatus(
  93             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
  94             @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
  95             @WebParam(name = "resourceTemplateUUID") @XmlElement(required = true) String resourceTemplateUUID)
  96             throws MsoRequestsDbException;
  97
  98     @WebMethod
  99     public void updateResourceOperationStatus(
 100             @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
 101             @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
 102             @WebParam(name = "resourceTemplateUUID") @XmlElement(required = true) String resourceTemplateUUID,
 103             @WebParam(name = "operType") @XmlElement(required = false) String operType,
 104             @WebParam(name = "resourceInstanceID") @XmlElement(required = false) String resourceInstanceID,
 105             @WebParam(name = "jobId") @XmlElement(required = false) String jobId,
 106             @WebParam(name = "status") @XmlElement(required = false) String status,
 107             @WebParam(name = "progress") @XmlElement(required = false) String progress,
 108             @WebParam(name = "errorCode") @XmlElement(required = false) String errorCode,
 109             @WebParam(name = "statusDescription") @XmlElement(required = false) String statusDescription)
 110             throws MsoRequestsDbException;
 111 }