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