Change the header to SO
[so.git] / adapters / mso-requests-db-adapter / src / main / java / org / openecomp / mso / 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.openecomp.mso.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
28 import org.openecomp.mso.adapters.requestsdb.exceptions.MsoRequestsDbException;
29 import org.openecomp.mso.requestsdb.InfraActiveRequests;
30 import org.openecomp.mso.requestsdb.SiteStatus;
31
32 /**
33  * MSO Request DB Adapter Web Service
34  */
35 @WebService(name = "RequestsDbAdapter", targetNamespace = "http://org.openecomp.mso/requestsdb")
36 public interface MsoRequestsDbAdapter {
37
38     @WebMethod
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 = "vfModuleName") @XmlElement(required = false) String vfModuleName) throws MsoRequestsDbException;
53
54     @WebMethod
55     public InfraActiveRequests getInfraRequest (@WebParam(name="requestId") @XmlElement(required = true) String requestId) throws MsoRequestsDbException;
56
57     @WebMethod
58     public boolean getSiteStatus (@WebParam(name="siteName") @XmlElement(required = true) String siteName);
59
60 }