engine/schema/src/main/java/com/cloud/network/dao/NetworkVO.java

// 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.dao;

import java.net.URI;
import java.util.Date;
import java.util.UUID;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.EnumType;
import javax.persistence.Enumerated;
import javax.persistence.Id;
import javax.persistence.Table;
import javax.persistence.TableGenerator;
import javax.persistence.Transient;

import org.apache.cloudstack.acl.ControlledEntity;
import org.apache.commons.lang3.StringUtils;

import com.cloud.network.Network;
import com.cloud.network.Networks.BroadcastDomainType;
import com.cloud.network.Networks.Mode;
import com.cloud.network.Networks.TrafficType;
import com.cloud.utils.NumbersUtil;
import com.cloud.utils.db.GenericDao;
import com.cloud.utils.net.NetUtils;
import org.apache.log4j.Logger;

/**
 * NetworkConfigurationVO contains information about a specific network.
 *
 */
@Entity
@Table(name = "networks")
public class NetworkVO implements Network {
    static final Logger s_logger = Logger.getLogger(NetworkVO.class);
    @Id
    @TableGenerator(name = "networks_sq", table = "sequence", pkColumnName = "name", valueColumnName = "value", pkColumnValue = "networks_seq", allocationSize = 1)
    @Column(name = "id")
    long id;

    @Column(name = "mode")
    @Enumerated(value = EnumType.STRING)
    Mode mode;

    @Column(name = "broadcast_domain_type")
    @Enumerated(value = EnumType.STRING)
    BroadcastDomainType broadcastDomainType;

    @Column(name = "traffic_type")
    @Enumerated(value = EnumType.STRING)
    TrafficType trafficType;

    @Column(name = "name")
    String name;

    @Column(name = "display_text")
    String displayText;

    @Column(name = "broadcast_uri")
    URI broadcastUri;

    @Column(name = "gateway")
    String gateway;

    @Column(name = "cidr")
    String cidr;

    @Column(name = "network_cidr")
    String networkCidr;

    @Column(name = "network_offering_id")
    long networkOfferingId;

    @Column(name = "vpc_id")
    Long vpcId;

    @Column(name = "physical_network_id")
    Long physicalNetworkId;

    @Column(name = "data_center_id")
    long dataCenterId;

    @Column(name = "related")
    long related;

    @Column(name = "guru_name")
    String guruName;

    @Column(name = "state")
    @Enumerated(value = EnumType.STRING)
    State state;

    @Column(name = "redundant")
    boolean redundant;

    @Column(name = "domain_id")
    long domainId;

    @Column(name = "account_id")
    long accountId;

    @Column(name = "set_fields")
    long setFields;

    @TableGenerator(name = "mac_address_seq", table = "op_networks", pkColumnName = "id", valueColumnName = "mac_address_seq", allocationSize = 1)
    @Transient
    long macAddress = 1;

    @Column(name = "guru_data", length = 1024)
    String guruData;

    @Column(name = "dns1")
    String dns1;

    @Column(name = "dns2")
    String dns2;

    @Column(name = "ip6Dns1")
    String ip6Dns1;

    @Column(name = "ip6Dns2")
    String ip6Dns2;

    @Column(name = "network_domain")
    String networkDomain;

    @Column(name = GenericDao.REMOVED_COLUMN)
    Date removed;

    @Column(name = GenericDao.CREATED_COLUMN)
    Date created;

    @Column(name = "reservation_id")
    String reservationId;

    @Column(name = "uuid")
    String uuid;

    @Column(name = "guest_type")
    @Enumerated(value = EnumType.STRING)
    Network.GuestType guestType;

    @Column(name = "acl_type")
    @Enumerated(value = EnumType.STRING)
    ControlledEntity.ACLType aclType;

    @Column(name = "restart_required")
    boolean restartRequired = false;

    @Column(name = "specify_ip_ranges")
    boolean specifyIpRanges = false;

    @Column(name = "ip6_gateway")
    String ip6Gateway;

    @Column(name = "ip6_cidr")
    String ip6Cidr;

    @Column(name = "display_network", updatable = true, nullable = false)
    protected boolean displayNetwork = true;

    @Column(name = "network_acl_id")
    Long networkACLId;

    @Column(name = "streched_l2")
    boolean strechedL2Network = false;

    @Column(name = "external_id")
    String externalId;

    @Transient
    String routerIp;

    @Transient
    String routerIpv6;

    @Transient
    transient String vlanIdAsUUID;

    @Transient
    boolean rollingRestart = false;

    @Transient
    PVlanType pVlanType;

    @Column(name = "public_mtu")
    Integer publicMtu;

    @Column(name = "private_mtu")
    Integer privateMtu;

    public NetworkVO() {
        uuid = UUID.randomUUID().toString();
    }

    /**
     * Constructor to be used for the adapters because it only initializes what's needed.
     * @param trafficType
     * @param mode
     * @param broadcastDomainType
     * @param networkOfferingId
     * @param state TODO
     * @param dataCenterId
     * @param physicalNetworkId TODO
     */
    public NetworkVO(TrafficType trafficType, Mode mode, BroadcastDomainType broadcastDomainType, long networkOfferingId, State state, long dataCenterId,
            Long physicalNetworkId, final boolean isRedundant) {
        this.trafficType = trafficType;
        this.mode = mode;
        this.broadcastDomainType = broadcastDomainType;
        this.networkOfferingId = networkOfferingId;
        this.dataCenterId = dataCenterId;
        this.physicalNetworkId = physicalNetworkId;
        this.redundant = isRedundant;
        if (state == null) {
            this.state = State.Allocated;
        } else {
            this.state = state;
        }
        id = -1;
        uuid = UUID.randomUUID().toString();
    }

    public NetworkVO(long id, Network that, long offeringId, String guruName, long domainId, long accountId, long related, String name, String displayText,
            String networkDomain, GuestType guestType, long dcId, Long physicalNetworkId, ACLType aclType, boolean specifyIpRanges, Long vpcId, final boolean isRedundant, String externalId) {
        this(id,
            that.getTrafficType(),
            that.getMode(),
            that.getBroadcastDomainType(),
            offeringId,
            domainId,
            accountId,
            related,
            name,
            displayText,
            networkDomain,
            guestType,
            dcId,
            physicalNetworkId,
            aclType,
            specifyIpRanges,
            vpcId,
            isRedundant);
        gateway = that.getGateway();
        cidr = that.getCidr();
        networkCidr = that.getNetworkCidr();
        broadcastUri = that.getBroadcastUri();
        broadcastDomainType = that.getBroadcastDomainType();
        this.guruName = guruName;
        state = that.getState();
        if (state == null) {
            state = State.Allocated;
        }
        uuid = UUID.randomUUID().toString();
        ip6Gateway = that.getIp6Gateway();
        ip6Cidr = that.getIp6Cidr();
        if (StringUtils.isNotBlank(that.getDns1())) {
            this.dns1 = that.getDns1();
        }
        if (StringUtils.isNotBlank(that.getDns2())) {
            this.dns2 = that.getDns2();
        }
        if (StringUtils.isNotBlank(that.getIp6Dns1())) {
            this.ip6Dns1 = that.getIp6Dns1();
        }
        if (StringUtils.isNotBlank(that.getIp6Dns2())) {
            this.ip6Dns2 = that.getIp6Dns2();
        }
        this.externalId = externalId;
        this.publicMtu = that.getPublicMtu();
        this.privateMtu = that.getPrivateMtu();
    }

    /**
     * Constructor for the actual DAO object.
     * @param trafficType
     * @param mode
     * @param broadcastDomainType
     * @param networkOfferingId
     * @param domainId
     * @param accountId
     * @param name
     * @param displayText
     * @param networkDomain
     * @param guestType TODO
     * @param aclType TODO
     * @param specifyIpRanges TODO
     * @param vpcId TODO
     * @param dataCenterId
     */
    public NetworkVO(long id, TrafficType trafficType, Mode mode, BroadcastDomainType broadcastDomainType, long networkOfferingId, long domainId, long accountId,
            long related, String name, String displayText, String networkDomain, GuestType guestType, long dcId, Long physicalNetworkId, ACLType aclType,
            boolean specifyIpRanges, Long vpcId, final boolean isRedundant) {
        this(trafficType, mode, broadcastDomainType, networkOfferingId, State.Allocated, dcId, physicalNetworkId, isRedundant);
        this.domainId = domainId;
        this.accountId = accountId;
        this.related = related;
        this.id = id;
        this.name = name;
        this.displayText = displayText;
        this.aclType = aclType;
        this.networkDomain = networkDomain;
        uuid = UUID.randomUUID().toString();
        this.guestType = guestType;
        this.specifyIpRanges = specifyIpRanges;
        this.vpcId = vpcId;
    }

    @Override
    public String getReservationId() {
        return reservationId;
    }

    public void setReservationId(String reservationId) {
        this.reservationId = reservationId;
    }

    @Override
    public State getState() {
        return state;
    }

    // don't use this directly when possible, use Network state machine instead
    public void setState(State state) {
        this.state = state;
    }

    @Override
    public boolean isRedundant() {
        return this.redundant;
    }

    public void setRedundant(boolean redundant) {
        this.redundant = redundant;
    }

    @Override
    public long getRelated() {
        return related;
    }

    public void setRelated(long related) {
        this.related = related;
    }

    @Override
    public long getId() {
        return id;
    }

    @Override
    public Mode getMode() {
        return mode;
    }

    @Override
    public long getAccountId() {
        return accountId;
    }

    @Override
    public long getDomainId() {
        return domainId;
    }

    @Override
    public long getNetworkOfferingId() {
        return networkOfferingId;
    }

    public void setNetworkOfferingId(long networkOfferingId) {
        this.networkOfferingId = networkOfferingId;
    }

    public void setMode(Mode mode) {
        this.mode = mode;
    }

    @Override
    public BroadcastDomainType getBroadcastDomainType() {
        return broadcastDomainType;
    }

    public String getGuruData() {
        return guruData;
    }

    public void setGuruData(String guruData) {
        this.guruData = guruData;
    }

    @Override
    public String getGuruName() {
        return guruName;
    }

    public void setGuruName(String guruName) {
        this.guruName = guruName;
    }

    public void setBroadcastDomainType(BroadcastDomainType broadcastDomainType) {
        this.broadcastDomainType = broadcastDomainType;
    }

    @Override
    public String getNetworkDomain() {
        return networkDomain;
    }

    public void setNetworkDomain(String networkDomain) {
        this.networkDomain = networkDomain;
    }

    @Override
    public TrafficType getTrafficType() {
        return trafficType;
    }

    @Override
    public void setTrafficType(TrafficType trafficType) {
        this.trafficType = trafficType;
    }

    @Override
    public String getGateway() {
        return gateway;
    }

    public void setGateway(String gateway) {
        this.gateway = 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 feature is configured for a Guest network, "network_cidr" is the Effective network cidr for the network,
    //  "cidr" will still continue to be the effective address space for CloudStack managed vms in that Guest network
    @Override
    public String getCidr() {
        return cidr;
    }

    public void setCidr(String cidr) {
        this.cidr = cidr;
    }

    // "networkcidr" is the network CIDR of the guest network which is configured with IP reservation feature
    // It is the summation of "cidr" and the reservedIPrange(the address space used for non cloudstack purposes.)
    //  For networks not using IP reservation "networkcidr" is always null
    @Override
    public String getNetworkCidr() {
        return networkCidr;
    }

    public void setNetworkCidr(String networkCidr) {
        this.networkCidr = networkCidr;
    }

    @Override
    public URI getBroadcastUri() {
        return broadcastUri;
    }

    public void setBroadcastUri(URI broadcastUri) {
        this.broadcastUri = broadcastUri;
    }

    @Override
    public int hashCode() {
        return NumbersUtil.hash(id);
    }

    @Override
    public Long getPhysicalNetworkId() {
        return physicalNetworkId;
    }

    @Override
    public void setPhysicalNetworkId(Long physicalNetworkId) {
        this.physicalNetworkId = physicalNetworkId;
    }

    @Override
    public long getDataCenterId() {
        return dataCenterId;
    }

    @Override
    public String getDns1() {
        return dns1;
    }

    public void setDns1(String dns) {
        dns1 = dns;
    }

    @Override
    public String getDns2() {
        return dns2;
    }

    public void setDns2(String dns) {
        dns2 = dns;
    }

    @Override
    public String getIp6Dns1() {
        return ip6Dns1;
    }

    public void setIp6Dns1(String ip6Dns1) {
        this.ip6Dns1 = ip6Dns1;
    }

    @Override
    public String getIp6Dns2() {
        return ip6Dns2;
    }

    public void setIp6Dns2(String ip6Dns2) {
        this.ip6Dns2 = ip6Dns2;
    }

    @Override
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @Override
    public String getDisplayText() {
        return displayText;
    }

    public void setDisplayText(String displayText) {
        this.displayText = displayText;
    }

    public Date getRemoved() {
        return removed;
    }

    public void setRemoved(Date removed) {
        this.removed = removed;
    }

    public Date getCreated() {
        return created;
    }

    public void setCreated(Date created) {
        this.created = created;
    }

    @Override
    public Network.GuestType getGuestType() {
        return guestType;
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof NetworkVO)) {
            return false;
        }
        NetworkVO that = (NetworkVO)obj;
        if (trafficType != that.trafficType) {
            return false;
        }

        if ((cidr == null && that.cidr != null) || (cidr != null && that.cidr == null)) {
            return false;
        }

        if (cidr == null && that.cidr == null) {
            return true;
        }

        return NetUtils.isNetworkAWithinNetworkB(cidr, that.cidr);
    }

    @Override
    public String toString() {
        return String.format("Network {\"id\": %s, \"name\": \"%s\", \"uuid\": \"%s\", \"networkofferingid\": %d}", id, name, uuid, networkOfferingId);
    }

    @Override
    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

    @Override
    public ControlledEntity.ACLType getAclType() {
        return aclType;
    }

    public void setRestartRequired(boolean restartRequired) {
        this.restartRequired = restartRequired;
    }

    @Override
    public boolean isRestartRequired() {
        return restartRequired;
    }

    @Override
    public boolean getSpecifyIpRanges() {
        return specifyIpRanges;
    }

    @Override
    public Long getVpcId() {
        return vpcId;
    }

    @Override
    public String getIp6Cidr() {
        return ip6Cidr;
    }

    public void setIp6Cidr(String ip6Cidr) {
        this.ip6Cidr = ip6Cidr;
    }

    @Override
    public String getIp6Gateway() {
        return ip6Gateway;
    }

    public void setIp6Gateway(String ip6Gateway) {
        this.ip6Gateway = ip6Gateway;
    }

    @Override()
    public boolean getDisplayNetwork() {
        return displayNetwork;
    }

    public void setDisplayNetwork(boolean displayNetwork) {
        this.displayNetwork = displayNetwork;
    }

    @Override
    public boolean isDisplay(){
        return displayNetwork;
    }

    @Override
    public void setNetworkACLId(Long networkACLId) {
        this.networkACLId = networkACLId;
    }

    @Override
    public Long getNetworkACLId() {
        return networkACLId;
    }

    @Override
    public Class<?> getEntityType() {
        return Network.class;
    }

    @Override
    public boolean isStrechedL2Network() {
        return strechedL2Network;
    }

    public void setStrechedL2Network(boolean strechedL2Network) {
        this.strechedL2Network = strechedL2Network;
    }

    public void setVpcId(Long vpcId) {
        this.vpcId = vpcId;
    }

    public String getExternalId() {
        return externalId;
    }

    public void setExternalId(String externalId) {
        this.externalId = externalId;
    }

    public String getVlanIdAsUUID() {
        return vlanIdAsUUID;
    }

    public void setVlanIdAsUUID(String vlanIdAsUUID) {
        this.vlanIdAsUUID = vlanIdAsUUID;
    }

    public boolean isRollingRestart() {
        return rollingRestart;
    }

    public void setRollingRestart(boolean rollingRestart) {
        this.rollingRestart = rollingRestart;
    }

    public PVlanType getPvlanType() {
        return pVlanType;
    }

    public void setPvlanType(PVlanType pvlanType) {
        this.pVlanType = pvlanType;
    }

    public String getRouterIp() {
        return routerIp;
    }

    public void setRouterIp(String routerIp) {
        this.routerIp = routerIp;
    }

    public String getRouterIpv6() {
        return routerIpv6;
    }

    public void setRouterIpv6(String routerIpv6) {
        this.routerIpv6 = routerIpv6;
    }

    public Integer getPublicMtu() {
        return publicMtu;
    }

    public void setPublicMtu(Integer publicMtu) {
        this.publicMtu = publicMtu;
    }

    public Integer getPrivateMtu() {
        return privateMtu;
    }

    public void setPrivateMtu(Integer privateMtu) {
        this.privateMtu = privateMtu;
    }
}