2 * ============LICENSE_START=======================================================
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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=========================================================
21 package org.onap.so.adapters.requestsdb;
23 import javax.jws.WebMethod;
24 import javax.jws.WebParam;
25 import javax.jws.WebService;
26 import javax.xml.bind.annotation.XmlElement;
28 import org.onap.so.adapters.requestsdb.exceptions.MsoRequestsDbException;
29 import org.onap.so.db.request.beans.InfraActiveRequests;
30 import org.onap.so.db.request.beans.ResourceOperationStatus;
33 * MSO Request DB Adapter Web Service
35 @WebService(name = "RequestsDbAdapter", targetNamespace = "http://org.onap.so/requestsdb")
36 public interface MsoRequestsDbAdapter {
39 public void updateInfraRequest(@WebParam(name = "requestId") @XmlElement(required = true) String requestId,
40 @WebParam(name = "lastModifiedBy") @XmlElement(required = true) String lastModifiedBy,
41 @WebParam(name = "statusMessage") @XmlElement(required = false) String statusMessage,
42 @WebParam(name = "responseBody") @XmlElement(required = false) String responseBody,
43 @WebParam(name = "requestStatus") @XmlElement(required = false) RequestStatusType requestStatus,
44 @WebParam(name = "progress") @XmlElement(required = false) String progress,
45 @WebParam(name = "vnfOutputs") @XmlElement(required = false) String vnfOutputs,
46 @WebParam(name = "serviceInstanceId") @XmlElement(required = false) String serviceInstanceId,
47 @WebParam(name = "networkId") @XmlElement(required = false) String networkId,
48 @WebParam(name = "vnfId") @XmlElement(required = false) String vnfId,
49 @WebParam(name = "vfModuleId") @XmlElement(required = false) String vfModuleId,
50 @WebParam(name = "volumeGroupId") @XmlElement(required = false) String volumeGroupId,
51 @WebParam(name = "serviceInstanceName") @XmlElement(required = false) String serviceInstanceName,
52 @WebParam(name = "configurationId") @XmlElement(required = false) String configurationId,
53 @WebParam(name = "configurationName") @XmlElement(required = false) String configurationName,
54 @WebParam(name = "vfModuleName") @XmlElement(required = false) String vfModuleName)
55 throws MsoRequestsDbException;
58 public InfraActiveRequests getInfraRequest(
59 @WebParam(name = "requestId") @XmlElement(required = true) String requestId) throws MsoRequestsDbException;
62 public boolean getSiteStatus(@WebParam(name = "siteName") @XmlElement(required = true) String siteName);
65 public void updateServiceOperationStatus(
66 @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
67 @WebParam(name = "operationId") @XmlElement(required = false) String operationId,
68 @WebParam(name = "operationType") @XmlElement(required = false) String operationType,
69 @WebParam(name = "userId") @XmlElement(required = false) String userId,
70 @WebParam(name = "result") @XmlElement(required = false) String result,
71 @WebParam(name = "operationContent") @XmlElement(required = false) String operationContent,
72 @WebParam(name = "progress") @XmlElement(required = false) String progress,
73 @WebParam(name = "reason") @XmlElement(required = false) String reason) throws MsoRequestsDbException;
76 public void initServiceOperationStatus(
77 @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
78 @WebParam(name = "operationId") @XmlElement(required = false) String operationId,
79 @WebParam(name = "operationType") @XmlElement(required = false) String operationType,
80 @WebParam(name = "userId") @XmlElement(required = false) String userId,
81 @WebParam(name = "result") @XmlElement(required = false) String result,
82 @WebParam(name = "operationContent") @XmlElement(required = false) String operationContent,
83 @WebParam(name = "progress") @XmlElement(required = false) String progress,
84 @WebParam(name = "reason") @XmlElement(required = false) String reason) throws MsoRequestsDbException;
87 public void initResourceOperationStatus(@WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
88 @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
89 @WebParam(name = "operationType") @XmlElement(required = true) String operationType,
90 @WebParam(name = "resourceTemplateUUIDs") @XmlElement(required = true) String resourceTemplateUUIDs)
91 throws MsoRequestsDbException;
94 public ResourceOperationStatus getResourceOperationStatus(
95 @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
96 @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
97 @WebParam(name = "resourceTemplateUUID") @XmlElement(required = true) String resourceTemplateUUID)
98 throws MsoRequestsDbException;
101 public void updateResourceOperationStatus(
102 @WebParam(name = "serviceId") @XmlElement(required = true) String serviceId,
103 @WebParam(name = "operationId") @XmlElement(required = true) String operationId,
104 @WebParam(name = "resourceTemplateUUID") @XmlElement(required = true) String resourceTemplateUUID,
105 @WebParam(name = "operType") @XmlElement(required = false) String operType,
106 @WebParam(name = "resourceInstanceID") @XmlElement(required = false) String resourceInstanceID,
107 @WebParam(name = "jobId") @XmlElement(required = false) String jobId,
108 @WebParam(name = "status") @XmlElement(required = false) String status,
109 @WebParam(name = "progress") @XmlElement(required = false) String progress,
110 @WebParam(name = "errorCode") @XmlElement(required = false) String errorCode,
111 @WebParam(name = "statusDescription") @XmlElement(required = false) String statusDescription)
112 throws MsoRequestsDbException;