1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
/*-
* ============LICENSE_START=======================================================
* OPENECOMP - MSO
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.openecomp.mso.adapters.network;
import java.util.List;
import java.util.Map;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebParam.Mode;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.ws.Holder;
import org.openecomp.mso.adapters.network.exceptions.NetworkException;
import org.openecomp.mso.entity.MsoRequest;
import org.openecomp.mso.openstack.beans.NetworkRollback;
import org.openecomp.mso.openstack.beans.NetworkStatus;
import org.openecomp.mso.openstack.beans.Subnet;
@WebService (name="NetworkAdapter", targetNamespace="http://org.openecomp.mso/network")
public interface MsoNetworkAdapter
{
// TODO: Rename all of these to include Vlan in the service name? At least for the
// create and update calls, since they are specific to VLAN-based provider networks.
/**
* This is the "Create Network" Web Service Endpoint definition.
*/
@WebMethod
public void createNetwork (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkName") @XmlElement(required=true) String networkName,
@WebParam(name="physicalNetworkName") String physicalNetworkName,
@WebParam(name="vlans") List<Integer> vlans,
@WebParam(name="failIfExists") Boolean failIfExists,
@WebParam(name="backout") Boolean backout,
@WebParam(name="subnets") List<Subnet> subnets,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="networkId", mode=Mode.OUT) Holder<String> networkId,
@WebParam(name="neutronNetworkId", mode=Mode.OUT) Holder<String> neutronNetworkId,
@WebParam(name="subnetIdMap", mode=Mode.OUT) Holder<Map<String, String>> subnetIdMap,
@WebParam(name="rollback", mode=Mode.OUT) Holder<NetworkRollback> rollback )
throws NetworkException;
@WebMethod
public void createNetworkContrail (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkName") @XmlElement(required=true) String networkName,
@WebParam(name="routeTargets") List<String> routeTargets,
@WebParam(name="shared") String shared,
@WebParam(name="external") String external,
@WebParam(name="failIfExists") Boolean failIfExists,
@WebParam(name="backout") Boolean backout,
@WebParam(name="subnets") List<Subnet> subnets,
@WebParam(name="policyFqdns") List<String> policyFqdns,
@WebParam(name="routeTableFqdns") List<String> routeTableFqdns,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="networkId", mode=Mode.OUT) Holder<String> networkId,
@WebParam(name="neutronNetworkId", mode=Mode.OUT) Holder<String> neutronNetworkId,
@WebParam(name="networkFqdn", mode=Mode.OUT) Holder<String> networkFqdn,
@WebParam(name="subnetIdMap", mode=Mode.OUT) Holder<Map<String, String>> subnetIdMap,
@WebParam(name="rollback", mode=Mode.OUT) Holder<NetworkRollback> rollback )
throws NetworkException;
/**
* This is the "Update VLANs" Web Service Endpoint definition.
* This webservice replaces the set of VLANs on a network.
*/
@WebMethod
public void updateNetwork (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkId") @XmlElement(required=true) String networkId,
@WebParam(name="networkName") @XmlElement(required=true) String networkName,
@WebParam(name="physicalNetworkName") @XmlElement(required=true) String physicalNetworkName,
@WebParam(name="vlans") @XmlElement(required=true) List<Integer> vlans,
@WebParam(name="subnets") List<Subnet> subnets,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="subnetIdMap", mode=Mode.OUT) Holder<Map<String, String>> subnetIdMap,
@WebParam(name="rollback", mode=Mode.OUT) Holder<NetworkRollback> rollback )
throws NetworkException;
@WebMethod
public void updateNetworkContrail (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkId") @XmlElement(required=true) String networkId,
@WebParam(name="networkName") @XmlElement(required=true) String networkName,
@WebParam(name="routeTargets") List<String> routeTargets,
@WebParam(name="shared") String shared,
@WebParam(name="external") String external,
@WebParam(name="subnets") List<Subnet> subnets,
@WebParam(name="policyFqdns") List<String> policyFqdns,
@WebParam(name="routeTableFqdns") List<String> routeTableFqdns,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="subnetIdMap", mode=Mode.OUT) Holder<Map<String, String>> subnetIdMap,
@WebParam(name="rollback", mode=Mode.OUT) Holder<NetworkRollback> rollback )
throws NetworkException;
/**
* TODO:
* This is the "Add VLAN" Web Service Endpoint definition.
* This webservice adds a VLAN to a network.
* This service assumes that PO supports querying the current vlans in real time.
* Otherwise, the caller must have the complete list and should use updateVlans instead.
@WebMethod
public void addVlan (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkId") @XmlElement(required=true) String networkId,
@WebParam(name="physicalNetworkName") @XmlElement(required=true) String physicalNetworkName,
@WebParam(name="vlan") @XmlElement(required=true) Integer vlan,
@WebParam(name="rollback", mode=Mode.OUT) Holder<NetworkRollback> rollback )
throws NetworkException;
*/
/**
* TODO:
* This is the "Remove VLAN" Web Service Endpoint definition.
* This webservice removes a VLAN from a network.
* This service assumes that PO supports querying the current vlans in real time.
* Otherwise, the caller must have the complete list and should use updateVlans instead.
*
* This service returns an indicator (noMoreVLans) if the VLAN that was removed was
* the last one on the network.
*
* It is not clear that Rollback will work for delete. The network can be
* recreated from the NetworkRollback object, but the network ID (and stack ID
* for Heat-based orchestration) will be different. The caller will need to know
* to update these identifiers in the inventory DB (A&AI).
@WebMethod
public void removeVlan (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkId") @XmlElement(required=true) String networkId,
@WebParam(name="physicalNetworkName") @XmlElement(required=true) String physicalNetworkName,
@WebParam(name="vlan") @XmlElement(required=true) Integer vlan,
@WebParam(name="noMoreVlans", mode=Mode.OUT) Holder<Boolean> noMoreVlans,
@WebParam(name="rollback", mode=Mode.OUT) Holder<NetworkRollback> rollback )
throws NetworkException;
*/
/**
* This is the "Query Network" Web Service Endpoint definition.
* TODO: Should this just return the NetworkInfo complete structure?
*/
@WebMethod
public void queryNetwork (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkNameOrId") @XmlElement(required=true) String networkNameOrId,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="networkExists", mode=Mode.OUT) Holder<Boolean> networkExists,
@WebParam(name="networkId", mode=Mode.OUT) Holder<String> networkId,
@WebParam(name="neutronNetworkId", mode=Mode.OUT) Holder<String> neutronNetworkId,
@WebParam(name="status", mode=Mode.OUT) Holder<NetworkStatus> status,
@WebParam(name="vlans", mode=Mode.OUT) Holder<List<Integer>> vlans,
@WebParam(name="subnetIdMap", mode=Mode.OUT) Holder<Map<String, String>> subnetIdMap)
throws NetworkException;
@WebMethod
public void queryNetworkContrail (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkNameOrId") @XmlElement(required=true) String networkNameOrId,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="networkExists", mode=Mode.OUT) Holder<Boolean> networkExists,
@WebParam(name="networkId", mode=Mode.OUT) Holder<String> networkId,
@WebParam(name="neutronNetworkId", mode=Mode.OUT) Holder<String> neutronNetworkId,
@WebParam(name="status", mode=Mode.OUT) Holder<NetworkStatus> status,
@WebParam(name="routeTargets", mode=Mode.OUT) Holder<List<String>> routeTargets,
@WebParam(name="subnetIdMap", mode=Mode.OUT) Holder<Map<String, String>> subnetIdMap)
throws NetworkException;
/**
* This is the "Delete Network" Web Service endpoint definition.
*/
@WebMethod
public void deleteNetwork (@WebParam(name="cloudSiteId") @XmlElement(required=true) String cloudSiteId,
@WebParam(name="tenantId") @XmlElement(required=true) String tenantId,
@WebParam(name="networkType") @XmlElement(required=true) String networkType,
@WebParam(name="networkId") @XmlElement(required=true) String networkId,
@WebParam(name="request") MsoRequest msoRequest,
@WebParam(name="networkDeleted", mode=Mode.OUT) Holder<Boolean> networkDeleted)
throws NetworkException;
/**
* This is the "Rollback Network" Web Service endpoint definition.
*/
@WebMethod
public void rollbackNetwork (@WebParam(name="rollback") @XmlElement(required=true) NetworkRollback rollback)
throws NetworkException;
@WebMethod
public void healthCheck ();
}
|
