content: // Licensed to the Apache Software Foundation (ASF) under one
  // or more contributor license agreements.  See the NOTICE file
  // distributed with this work for additional information
  // regarding copyright ownership.  The ASF licenses this file
  // to you 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.
  package com.cloud.network;
  
  import java.io.Serializable;
  import java.net.URI;
  import java.util.ArrayList;
  import java.util.Date;
  import java.util.List;
  
  import org.apache.cloudstack.acl.ControlledEntity;
  import org.apache.cloudstack.api.Displayable;
  import org.apache.cloudstack.api.Identity;
  import org.apache.cloudstack.api.InternalIdentity;
  import org.apache.commons.lang.builder.ToStringBuilder;
  import org.apache.commons.lang.builder.ToStringStyle;
  import org.apache.commons.lang3.StringUtils;
  
  import com.cloud.exception.InvalidParameterValueException;
  import com.cloud.network.Networks.BroadcastDomainType;
  import com.cloud.network.Networks.Mode;
  import com.cloud.network.Networks.TrafficType;
  import com.cloud.utils.fsm.StateMachine2;
  import com.cloud.utils.fsm.StateObject;
  
  /**
   * owned by an account.
   */
  public interface Network extends ControlledEntity, StateObject<Network.State>, InternalIdentity, Identity, Serializable, Displayable {
  
      enum GuestType {
          Shared, Isolated, L2;
  
          public static GuestType fromValue(String type) {
              if (StringUtils.isBlank(type)) {
                  return null;
              } else if (type.equalsIgnoreCase("Shared")) {
                  return Shared;
              } else if (type.equalsIgnoreCase("Isolated")) {
                  return Isolated;
              } else if (type.equalsIgnoreCase("L2")) {
                  return L2;
              } else {
                  throw new InvalidParameterValueException("Unexpected Guest type : " + type);
              }
          }
      }
  
      enum PVlanType {
          Community, Isolated, Promiscuous;
  
          static PVlanType fromValue(String type) {
              if (StringUtils.isBlank(type)) {
                  return null;
              } else if (type.equalsIgnoreCase("promiscuous") || type.equalsIgnoreCase("p")) {
                  return Promiscuous;
              } else if (type.equalsIgnoreCase("community") || type.equalsIgnoreCase("c")) {
                  return Community;
              } else if (type.equalsIgnoreCase("isolated") || type.equalsIgnoreCase("i")) {
                  return Isolated;
              } else {
                  throw new InvalidParameterValueException("Unexpected Private VLAN type: " + type);
              }
          }
      }
  
      enum Routing {
          Static, Dynamic;
  
          public static Routing fromValue(String type) {
              if (StringUtils.isBlank(type)) {
                  return null;
              } else if (type.equalsIgnoreCase("Static")) {
                  return Static;
              } else if (type.equalsIgnoreCase("Dynamic")) {
                  return Dynamic;
              } else {
                  throw new InvalidParameterValueException("Unexpected Routing type : " + type);
              }
          }
      }
  
      String updatingInSequence = "updatingInSequence";
      String hideIpAddressUsage = "hideIpAddressUsage";
  
      class Service {
          private static List<Service> supportedServices = new ArrayList<Service>();
  
          public static final Service Vpn = new Service("Vpn", Capability.SupportedVpnProtocols, Capability.VpnTypes);
          public static final Service Dhcp = new Service("Dhcp", Capability.ExtraDhcpOptions);
          public static final Service Dns = new Service("Dns", Capability.AllowDnsSuffixModification);
          public static final Service Gateway = new Service("Gateway", Capability.RedundantRouter);
          public static final Service Firewall = new Service("Firewall", Capability.SupportedProtocols, Capability.MultipleIps, Capability.TrafficStatistics,
                  Capability.SupportedTrafficDirection, Capability.SupportedEgressProtocols);
          public static final Service Lb = new Service("Lb", Capability.SupportedLBAlgorithms, Capability.SupportedLBIsolation, Capability.SupportedProtocols,
                  Capability.TrafficStatistics, Capability.LoadBalancingSupportedIps, Capability.SupportedStickinessMethods, Capability.ElasticLb, Capability.LbSchemes);
          public static final Service UserData = new Service("UserData");
          public static final Service SourceNat = new Service("SourceNat", Capability.SupportedSourceNatTypes, Capability.RedundantRouter);
          public static final Service StaticNat = new Service("StaticNat", Capability.ElasticIp);
          public static final Service PortForwarding = new Service("PortForwarding");
          public static final Service SecurityGroup = new Service("SecurityGroup");
          public static final Service NetworkACL = new Service("NetworkACL", Capability.SupportedProtocols);
          public static final Service Connectivity = new Service("Connectivity", Capability.DistributedRouter, Capability.RegionLevelVpc, Capability.StretchedL2Subnet,
                  Capability.NoVlan, Capability.PublicAccess);
  
          private final String name;
          private final Capability[] caps;
  
          public Service(String name, Capability... caps) {
              this.name = name;
              this.caps = caps;
              supportedServices.add(this);
          }
  
          public String getName() {
              return name;
          }
  
          public Capability[] getCapabilities() {
              return caps;
          }
  
          public boolean containsCapability(Capability cap) {
              boolean success = false;
              if (caps != null) {
                  int length = caps.length;
                  for (int i = 0; i < length; i++) {
                      if (caps[i].getName().equalsIgnoreCase(cap.getName())) {
                          success = true;
                          break;
                      }
                  }
              }
  
              return success;
          }
  
          @Override public String toString() {
              return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
                      .append("name", name)
                      .toString();
          }
  
          public static Service getService(String serviceName) {
              for (Service service : supportedServices) {
                  if (service.getName().equalsIgnoreCase(serviceName)) {
                      return service;
                  }
              }
              return null;
          }
  
          public static List<Service> listAllServices() {
              return supportedServices;
          }
      }
  
      /**
       * Provider -> NetworkElement must always be one-to-one mapping. Thus for each NetworkElement we need a separate Provider added in here.
       */
      public static class Provider {
          private static List<Provider> supportedProviders = new ArrayList<Provider>();
  
          public static final Provider VirtualRouter = new Provider("VirtualRouter", false, false);
          public static final Provider JuniperContrailRouter = new Provider("JuniperContrailRouter", false);
          public static final Provider JuniperContrailVpcRouter = new Provider("JuniperContrailVpcRouter", false);
          public static final Provider JuniperSRX = new Provider("JuniperSRX", true);
          public static final Provider PaloAlto = new Provider("PaloAlto", true);
          public static final Provider F5BigIp = new Provider("F5BigIp", true);
          public static final Provider Netscaler = new Provider("Netscaler", true);
          public static final Provider ExternalDhcpServer = new Provider("ExternalDhcpServer", true);
          public static final Provider ExternalGateWay = new Provider("ExternalGateWay", true);
          public static final Provider ElasticLoadBalancerVm = new Provider("ElasticLoadBalancerVm", false);
          public static final Provider SecurityGroupProvider = new Provider("SecurityGroupProvider", false);
          public static final Provider VPCVirtualRouter = new Provider("VpcVirtualRouter", false);
          public static final Provider None = new Provider("None", false);
          // NiciraNvp is not an "External" provider, otherwise we get in trouble with NetworkServiceImpl.providersConfiguredForExternalNetworking
          public static final Provider NiciraNvp = new Provider("NiciraNvp", false);
          public static final Provider InternalLbVm = new Provider("InternalLbVm", false);
          public static final Provider CiscoVnmc = new Provider("CiscoVnmc", true);
          // add new Ovs provider
          public static final Provider Ovs = new Provider("Ovs", false);
          public static final Provider Opendaylight = new Provider("Opendaylight", false);
          public static final Provider BrocadeVcs = new Provider("BrocadeVcs", false);
          // add GloboDns provider
          public static final Provider GloboDns = new Provider("GloboDns", true);
          // add Big Switch Bcf Provider
          public static final Provider BigSwitchBcf = new Provider("BigSwitchBcf", false);
          //Add ConfigDrive provider
          public static final Provider ConfigDrive = new Provider("ConfigDrive", false);
          //Add Tungsten Fabric provider
          public static final Provider Tungsten = new Provider("Tungsten", false);
  
          public static final Provider Nsx = new Provider("Nsx", false);
          public static final Provider Netris = new Provider("Netris", false);
  
          private final String name;
          private final boolean isExternal;
  
          // set to true, if on network shutdown resources (acquired/configured at implemented phase) needed to cleaned up. set to false
          // if no clean-up is required ( for e.g appliance based providers like VirtualRouter, VM is destroyed so there is no need to cleanup).
          private final boolean needCleanupOnShutdown;
  
          public Provider(String name, boolean isExternal) {
              this.name = name;
              this.isExternal = isExternal;
              needCleanupOnShutdown = true;
              supportedProviders.add(this);
          }
  
          public Provider(String name, boolean isExternal, boolean needCleanupOnShutdown) {
              this.name = name;
              this.isExternal = isExternal;
              this.needCleanupOnShutdown = needCleanupOnShutdown;
              supportedProviders.add(this);
          }
  
          public String getName() {
              return name;
          }
  
          public boolean isExternal() {
              return isExternal;
          }
  
          public boolean cleanupNeededOnShutdown() {
              return needCleanupOnShutdown;
          }
  
          public static Provider getProvider(String providerName) {
              for (Provider provider : supportedProviders) {
                  if (provider.getName().equalsIgnoreCase(providerName)) {
                      return provider;
                  }
              }
              return null;
          }
  
          @Override public String toString() {
              return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
                      .append("name", name)
                      .toString();
          }
      }
  
      public static class Capability {
  
          private static List<Capability> supportedCapabilities = new ArrayList<>();
  
          public static final Capability SupportedProtocols = new Capability("SupportedProtocols");
          public static final Capability SupportedLBAlgorithms = new Capability("SupportedLbAlgorithms");
          public static final Capability SupportedLBIsolation = new Capability("SupportedLBIsolation");
          public static final Capability SupportedStickinessMethods = new Capability("SupportedStickinessMethods");
          public static final Capability MultipleIps = new Capability("MultipleIps");
          public static final Capability SupportedSourceNatTypes = new Capability("SupportedSourceNatTypes");
          public static final Capability SupportedVpnProtocols = new Capability("SupportedVpnTypes");
          public static final Capability VpnTypes = new Capability("VpnTypes");
          public static final Capability TrafficStatistics = new Capability("TrafficStatistics");
          public static final Capability LoadBalancingSupportedIps = new Capability("LoadBalancingSupportedIps");
          public static final Capability AllowDnsSuffixModification = new Capability("AllowDnsSuffixModification");
          public static final Capability RedundantRouter = new Capability("RedundantRouter");
          public static final Capability ElasticIp = new Capability("ElasticIp");
          public static final Capability AssociatePublicIP = new Capability("AssociatePublicIP");
          public static final Capability ElasticLb = new Capability("ElasticLb");
          public static final Capability AutoScaleCounters = new Capability("AutoScaleCounters");
          public static final Capability InlineMode = new Capability("InlineMode");
          public static final Capability SupportedTrafficDirection = new Capability("SupportedTrafficDirection");
          public static final Capability SupportedEgressProtocols = new Capability("SupportedEgressProtocols");
          public static final Capability HealthCheckPolicy = new Capability("HealthCheckPolicy");
          public static final Capability SslTermination = new Capability("SslTermination");
          public static final Capability LbSchemes = new Capability("LbSchemes");
          public static final Capability DhcpAccrossMultipleSubnets = new Capability("DhcpAccrossMultipleSubnets");
          public static final Capability DistributedRouter = new Capability("DistributedRouter");
          public static final Capability StretchedL2Subnet = new Capability("StretchedL2Subnet");
          public static final Capability RegionLevelVpc = new Capability("RegionLevelVpc");
          public static final Capability NoVlan = new Capability("NoVlan");
          public static final Capability PublicAccess = new Capability("PublicAccess");
          public static final Capability ExtraDhcpOptions = new Capability("ExtraDhcpOptions");
          public static final Capability VmAutoScaling = new Capability("VmAutoScaling");
  
          private final String name;
  
          public Capability(String name) {
              this.name = name;
              supportedCapabilities.add(this);
          }
  
          public String getName() {
              return name;
          }
  
          public static Capability getCapability(String capabilityName) {
              for (Capability capability : supportedCapabilities) {
                  if (capability.getName().equalsIgnoreCase(capabilityName)) {
                      return capability;
                  }
              }
              return null;
          }
  
          @Override public String toString() {
              return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
                      .append("name", name)
                      .toString();
          }
      }
  
      enum Event {
          ImplementNetwork, DestroyNetwork, OperationSucceeded, OperationFailed;
      }
  
      public enum State {
  
          Allocated("Indicates the network configuration is in allocated but not setup"), Setup("Indicates the network configuration is setup"), Implementing(
                  "Indicates the network configuration is being implemented"), Implemented("Indicates the network configuration is in use"), Shutdown(
                  "Indicates the network configuration is being destroyed"), Destroy("Indicates that the network is destroyed");
  
          protected static final StateMachine2<State, Network.Event, Network> s_fsm = new StateMachine2<State, Network.Event, Network>();
  
          static {
              s_fsm.addTransition(State.Allocated, Event.ImplementNetwork, State.Implementing);
              s_fsm.addTransition(State.Implementing, Event.OperationSucceeded, State.Implemented);
              s_fsm.addTransition(State.Implementing, Event.OperationFailed, State.Shutdown);
              s_fsm.addTransition(State.Implemented, Event.DestroyNetwork, State.Shutdown);
              s_fsm.addTransition(State.Shutdown, Event.OperationSucceeded, State.Allocated);
              s_fsm.addTransition(State.Shutdown, Event.OperationFailed, State.Shutdown);
              s_fsm.addTransition(State.Setup, Event.DestroyNetwork, State.Destroy);
              s_fsm.addTransition(State.Allocated, Event.DestroyNetwork, State.Destroy);
          }
  
          public static StateMachine2<State, Network.Event, Network> getStateMachine() {
              return s_fsm;
          }
  
          String _description;
  
          private State(String description) {
              _description = description;
          }
      }
  
      public enum NetworkFilter {
          Account,        // return account networks that have been registered for or created by the calling user
          Domain,         // return domain networks that have been registered for or created by the calling user
          AccountDomain,  // return account and domain networks that have been registered for or created by the calling user
          Shared,         // including networks that have been granted to the calling user by another user
          All             // all networks (account, domain and shared)
      }
  
      public class IpAddresses {
          private String ip4Address;
          private String ip6Address;
          private String macAddress;
  
          public String getMacAddress() {
              return macAddress;
          }
  
          public void setMacAddress(String macAddress) {
              this.macAddress = macAddress;
          }
  
          public IpAddresses(String ip4Address, String ip6Address) {
              setIp4Address(ip4Address);
              setIp6Address(ip6Address);
          }
  
          public IpAddresses(String ipAddress, String ip6Address, String macAddress) {
              this(ipAddress, ip6Address);
              setMacAddress(macAddress);
          }
  
          public String getIp4Address() {
              return ip4Address;
          }
  
          public void setIp4Address(String ip4Address) {
              this.ip4Address = ip4Address;
          }
  
          public String getIp6Address() {
              return ip6Address;
          }
  
          public void setIp6Address(String ip6Address) {
              this.ip6Address = ip6Address;
          }
      }
  
      static final String AssociatedNetworkId = "AssociatedNetworkId";
  
      String getName();
  
      Mode getMode();
  
      BroadcastDomainType getBroadcastDomainType();
  
      TrafficType getTrafficType();
  
      String getGateway();
  
      void setGateway(String gateway);
  
      // "cidr" is the Cloudstack managed address space, all CloudStack managed vms get IP address from "cidr",
      // In general "cidr" also serves as the network CIDR
      // But in case IP reservation is configured for a Guest network, "networkcidr" is the Effective network CIDR for that network,
      // "cidr" will still continue to be the effective address space for CloudStack managed vms in that Guest network
      String getCidr();
  
      void setCidr(String cidr);
  
      // "networkcidr" is the network CIDR of the guest network which uses IP reservation.
      // It is the summation of "cidr" and the reservedIPrange(the address space used for non CloudStack purposes).
      // For networks not configured with IP reservation, "networkcidr" is always null
      String getNetworkCidr();
  
      String getIp6Gateway();
  
      String getIp6Cidr();
  
      long getDataCenterId();
  
      long getAccountId();
  
      long getNetworkOfferingId();
  
      @Override
      State getState();
  
      boolean isRedundant();
  
      boolean isRollingRestart();
  
      long getRelated();
  
      URI getBroadcastUri();
  
      String getDisplayText();
  
      String getReservationId();
  
      String getNetworkDomain();
  
      GuestType getGuestType();
  
      Long getPhysicalNetworkId();
  
      void setPhysicalNetworkId(Long physicalNetworkId);
  
      public void setTrafficType(TrafficType type);
  
      ACLType getAclType();
  
      boolean isRestartRequired();
  
      boolean getSpecifyIpRanges();
  
      @Deprecated
      boolean getDisplayNetwork();
  
      boolean isDisplay();
  
      String getGuruName();
  
      /**
       * @return
       */
      Long getVpcId();
  
      Long getNetworkACLId();
  
      void setNetworkACLId(Long networkACLId);
  
      boolean isStrechedL2Network();
  
      String getExternalId();
  
      PVlanType getPvlanType();
  
      String getRouterIp();
  
      String getRouterIpv6();
  
      String getDns1();
  
      String getDns2();
  
      String getIp6Dns1();
  
      String getIp6Dns2();
  
      Date getCreated();
  
      Integer getPublicMtu();
  
      Integer getPrivateMtu();
  
      Integer getNetworkCidrSize();
  }
  