com.huawei.openstack4j.openstack.networking.domain.NeutronPort Maven / Gradle / Ivy

/*******************************************************************************
 * 	Copyright 2016 ContainX and OpenStack4j                                          
 * 	                                                                                 
 * 	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.                                                                     
 *******************************************************************************/
package com.huawei.openstack4j.openstack.networking.domain;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonRootName;
import com.huawei.openstack4j.model.common.builder.ResourceBuilder;
import com.huawei.openstack4j.model.network.AllowedAddressPair;
import com.huawei.openstack4j.model.network.ExtraDhcpOptCreate;
import com.huawei.openstack4j.model.network.IP;
import com.huawei.openstack4j.model.network.Port;
import com.huawei.openstack4j.model.network.State;
import com.huawei.openstack4j.model.network.builder.PortBuilder;
import com.huawei.openstack4j.openstack.common.ListResult;

import com.google.common.base.MoreObjects;
import com.google.common.collect.Lists;
import com.google.common.collect.Sets;

/**
 * A Neutron Port
 *
 * @author Jeremy Unruh
 */
@JsonRootName("port")
@JsonIgnoreProperties(ignoreUnknown = true)
public class NeutronPort implements Port {

	private static final long serialVersionUID = 1L;

	private String id;
	private String name;

	@JsonProperty("admin_state_up")
	private boolean adminStateUp = true;

	@JsonProperty("device_id")
	private String deviceId;

	@JsonProperty("device_owner")
	private String deviceOwner;

	@JsonProperty("fixed_ips")
	private Set fixedIps;

	@JsonProperty("allowed_address_pairs")
	private Set allowedAddressPairs;

	@JsonProperty("mac_address")
	private String macAddress;

	@JsonProperty("network_id")
	private String networkId;

	@JsonProperty("status")
	private State state;

	@JsonProperty("tenant_id")
	private String tenantId;

	@JsonProperty("security_groups")
	private List securityGroups;

	@JsonProperty("extra_dhcp_opts")
	private List extraDhcpOptCreates;

	@JsonProperty("port_security_enabled")
	private Boolean portSecurityEnabled;

	@JsonProperty("binding:host_id")
	private String hostId;

	@JsonProperty("binding:vif_type")
	private String vifType;

	@JsonProperty("binding:vif_details")
	private Map vifDetails;

	@JsonProperty("binding:vnic_type")
	private String vNicType;

	@JsonProperty("binding:profile")
	private Map profile;

	public static PortBuilder builder() {
		return new PortConcreteBuilder();
	}

	@Override
	public PortBuilder toBuilder() {
		return new PortConcreteBuilder(this);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getId() {
		return id;
	}

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getTenantId() {
		return tenantId;
	}

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

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean isAdminStateUp() {
		return adminStateUp;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getNetworkId() {
		return networkId;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getDeviceId() {
		return deviceId;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getDeviceOwner() {
		return deviceOwner;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Set getFixedIps() {
		return fixedIps;
	}

	/**
	* {@inheritDoc}
	*/
	@Override
	public Set getAllowedAddressPairs() {
		return allowedAddressPairs;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getMacAddress() {
		return macAddress;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public List getSecurityGroups() {
		return securityGroups;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getHostId() {
		return hostId;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getVifType() {
		return vifType;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Map getVifDetails() {
		return vifDetails;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getvNicType() {
		return vNicType;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public Map getProfile() {
		return profile;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setId(String id) {
		this.id = id;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setName(String name) {
		this.name = name;
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public void setTenantId(String tenantId) {
		this.tenantId = tenantId;
	}

	public void setHostId(String hostId) {
		this.hostId = hostId;
	}

	public void setVifType(String vifType) {
		this.vifType = vifType;
	}

	public void setVifDetails(Map vifDetails) {
		this.vifDetails = vifDetails;
	}

	public void setvNicType(String vNicType) {
		this.vNicType = vNicType;
	}

	public void setProfile(Map profile) {
		this.profile = profile;
	}

	/**
     * {@inheritDoc}
     */
    @Override
    public Boolean isPortSecurityEnabled() {
        return portSecurityEnabled;
    }


	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		return MoreObjects.toStringHelper(this).omitNullValues()
				    .add("id", id).add("name", name).add("adminStateUp", adminStateUp).add("deviceId", deviceId)
				    .add("deviceOwner", deviceOwner).add("fixedIps", fixedIps).add("macAddress", macAddress)
				    .add("networkId", networkId).add("tenantId", tenantId).add("securityGroups", securityGroups)
				    .add("allowed_address_pairs", allowedAddressPairs).add("port_security_enabled ", portSecurityEnabled)
				    .add("binding:host_id", hostId).add("binding:vif_type", vifType).add("binding:vif_details", vifDetails)
				    .add("binding:vnic_type", vNicType).add("binding:profile", profile)
				    .toString();
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public int hashCode() {
		return java.util.Objects.hash(id, name, adminStateUp, deviceId,
				deviceOwner, fixedIps, macAddress, networkId, tenantId,
				securityGroups, allowedAddressPairs, portSecurityEnabled, hostId,
				vifType, vifDetails, vNicType, profile);
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}

		if (obj instanceof NeutronPort) {
			NeutronPort that = (NeutronPort) obj;
			if (java.util.Objects.equals(id, that.id) &&
					java.util.Objects.equals(name, that.name) &&
					java.util.Objects.equals(adminStateUp, that.adminStateUp) &&
					java.util.Objects.equals(deviceId, that.deviceId) &&
					java.util.Objects.equals(deviceOwner, that.deviceOwner) &&
					java.util.Objects.equals(fixedIps, that.fixedIps) &&
					java.util.Objects.equals(macAddress, that.macAddress) &&
					java.util.Objects.equals(networkId, that.networkId) &&
					java.util.Objects.equals(tenantId, that.tenantId) &&
					java.util.Objects.equals(securityGroups, that.securityGroups) &&
					java.util.Objects.equals(allowedAddressPairs, that.allowedAddressPairs) &&
					java.util.Objects.equals(portSecurityEnabled, that.portSecurityEnabled) &&
					java.util.Objects.equals(hostId, that.hostId) &&
					java.util.Objects.equals(vifType, that.vifType) &&
					java.util.Objects.equals(vifDetails, that.vifDetails) &&
					java.util.Objects.equals(vNicType, that.vNicType) &&
					java.util.Objects.equals(profile, that.profile)) {
				return true;
			}
		}
		return false;
	}

	public static class Ports extends ListResult {

		private static final long serialVersionUID = 1L;

		@JsonProperty("ports")
		private List ports;

		@Override
		protected List value() {
			return ports;
		}
	}

	public static class PortConcreteBuilder extends ResourceBuilder implements PortBuilder {

		private NeutronPort m;

		PortConcreteBuilder() {
			this(new NeutronPort());
		}

		PortConcreteBuilder(NeutronPort port) {
			this.m = port;
		}
		@Override
		public PortBuilder networkId(String networkId) {
			m.networkId = networkId;
			return this;
		}

		@Override
		public PortBuilder deviceId(String deviceId) {
			m.deviceId = deviceId;
			return this;
		}

		@Override
		public PortBuilder deviceOwner(String deviceOwner) {
			m.deviceOwner = deviceOwner;
			return this;
		}

		@Override
		public PortBuilder macAddress(String macAddress) {
			m.macAddress = macAddress;
			return this;
		}

		@Override
		public PortBuilder fixedIp(String address, String subnetId) {
			if (m.fixedIps == null)
				m.fixedIps = Sets.newHashSet();

			m.fixedIps.add(new NeutronIP(address, subnetId));
			return this;
		}

		@Override
        public PortBuilder removeFixedIp(String address, String subnetId) {
			if (m.fixedIps == null)
			  m.fixedIps = Sets.newHashSet();

			Iterator iter = m.fixedIps.iterator();

			while (iter.hasNext()) {
			  NeutronIP fixedIP = iter.next();
			  if (fixedIP.getSubnetId() != null && fixedIP.getSubnetId().equals(subnetId) &&
			      fixedIP.getIpAddress() != null && fixedIP.getIpAddress().equals(address)) {
			    iter.remove();
			  }
			}

			return this;
		}

		@Override
		public PortBuilder allowedAddressPair(String ipAddress, String macAddress) {
			if (m.allowedAddressPairs == null)
				m.allowedAddressPairs = Sets.newHashSet();

			m.allowedAddressPairs.add(new NeutronAllowedAddressPair(ipAddress, macAddress));
			return this;
		}

		@Override
		public PortBuilder removeAddressPair(String ipAddress, String macAddress) {
			if (m.allowedAddressPairs == null)
				m.allowedAddressPairs = Sets.newHashSet();

			Iterator iter = m.allowedAddressPairs.iterator();

			while (iter.hasNext()) {
				NeutronAllowedAddressPair allowedAddress = iter.next();
				if (allowedAddress.getIpAddress() != null && allowedAddress.getIpAddress().equals(ipAddress) &&
						allowedAddress.getMacAddress() != null && allowedAddress.getMacAddress().equals(macAddress)) {
					iter.remove();
				}
			}

			return this;
		}


		@Override
		public PortBuilder adminState(boolean adminStateUp) {
			m.adminStateUp = adminStateUp;
			return this;
		}

		@Override
		public PortBuilder state(State state) {
			m.state = state;
			return this;
		}

		@Override
		public Port build() {
			return m;
		}

		@Override
		public PortBuilder from(Port in) {
			m = (NeutronPort) in;
			return this;
		}

		@Override
		protected Port reference() {
			return m;
		}

    @Override
        public PortBuilder extraDhcpOpt(ExtraDhcpOptCreate extraDhcpOptCreate) {
            if (m.extraDhcpOptCreates == null)
                m.extraDhcpOptCreates = Lists.newArrayList();
            m.extraDhcpOptCreates.add((NeutronExtraDhcpOptCreate)extraDhcpOptCreate);
            return this;
    }

		@Override
		public PortBuilder securityGroup(String groupName) {
			if(m.securityGroups==null){
				m.securityGroups = new ArrayList<>();
			}
			m.securityGroups.add(groupName);
			return this;
		}

        @Override
        public PortBuilder portSecurityEnabled(Boolean portSecurityEnabled) {
            m.portSecurityEnabled=portSecurityEnabled;
            return this;
        }

        @Override
        public PortBuilder hostId(String hostId) {
			m.hostId = hostId;
			return this;
    	}

        @Override
    	public PortBuilder vifType(String vifType) {
			m.vifType = vifType;
			return this;
    	}

        @Override
    	public PortBuilder vifDetails(Map vifDetails) {
			m.vifDetails = vifDetails;
			return this;
    	}

        @Override
    	public PortBuilder vNicType(String vNicType) {
			m.vNicType = vNicType;
			return this;
    	}

        @Override
    	public PortBuilder profile(Map profile) {
			m.profile = profile;
			return this;
    	}

	}

}