inet.ipaddr.format.validate.ParsedHostIdentifierStringQualifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ipaddress Show documentation
Library for handling IP addresses, both IPv4 and IPv6
There is a newer version: 5.5.1
/*
 * Copyright 2016-2018 Sean C Foley
 *
 * 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
 *     or at
 *     https://github.com/seancfoley/IPAddress/blob/master/LICENSE
 *
 * 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 inet.ipaddr.format.validate;

import java.io.Serializable;

import inet.ipaddr.IPAddress;
import inet.ipaddr.IPAddressStringParameters;
import inet.ipaddr.IPAddress.IPVersion;

/**
 * The result of parsing a qualifier for a host name or address, the qualifier being either a mask, prefix length, or zone that follows the string.
 * 
 * @author sfoley
 *
 */
public class ParsedHostIdentifierStringQualifier implements Serializable, Cloneable {

	private static final long serialVersionUID = 4L;

	/* if there is a prefix length for the address, this will be its numeric value */
	private Integer networkPrefixLength; //non-null for a prefix-only address, sometimes non-null for IPv4, IPv6

	/* if there is a port for the host, this will be its numeric value */
	private final Integer port; //non-null for a host with port
	private final CharSequence service; //non-null for host with a service instead of a port

	/* If instead of a prefix length a mask was provided, this is the mask.
	 * We can also have both a prefix length and mask if one is added when merging qualifiers  */
	private ParsedIPAddress mask;
	
	/* overrides the parsed mask if present */
	private IPAddress mergedMask;

	/* this is the IPv6 scope id or network interface name */
	private final CharSequence zone;

	ParsedHostIdentifierStringQualifier() {
		this(null, null, null, null, null);
	}
	
	ParsedHostIdentifierStringQualifier(CharSequence zone) {
		this(null, null, zone, null, null);
	}
	
	public ParsedHostIdentifierStringQualifier(CharSequence zone, int port) {
		this(null, null, zone, cachePorts(port), null);
	}
	
	public ParsedHostIdentifierStringQualifier(Integer networkPrefixLength, CharSequence zone) {
		this(networkPrefixLength, null, zone, null, null);
	}
	
	ParsedHostIdentifierStringQualifier(ParsedIPAddress mask, CharSequence zone) {
		this(null, mask, zone, null, null);
	}

	ParsedHostIdentifierStringQualifier(CharSequence zone, CharSequence service) {
		this(null, null, zone, null, service);
		if(zone != null && service != null) {
			throw new IllegalArgumentException();
		}
	}

	private ParsedHostIdentifierStringQualifier(Integer networkPrefixLength, ParsedIPAddress mask, CharSequence zone, Integer port, CharSequence service) {
		this.networkPrefixLength = networkPrefixLength;
		this.mask = mask;
		this.zone = zone;
		this.port = port;
		this.service = service;
	}
	
	private static Integer cachePorts(int i) {
		return ParsedAddressGrouping.cache(i);
	}

	private void overrideMask(ParsedHostIdentifierStringQualifier other) {
		if(other.mask != null) {
			this.mask = other.mask;
		}
	}
	
	private void overridePrefixLength(ParsedHostIdentifierStringQualifier other) {
		if(other.networkPrefixLength != null) {
			networkPrefixLength = other.networkPrefixLength;
		}
	}
	
	void overridePrefix(ParsedHostIdentifierStringQualifier other) {
		overridePrefixLength(other);
		overrideMask(other);
	}
	
	void merge(ParsedHostIdentifierStringQualifier other) {
		if(networkPrefixLength == null || 
				(other.networkPrefixLength != null && other.networkPrefixLength < networkPrefixLength)) {
			networkPrefixLength = other.networkPrefixLength;
		}
		if(mask == null) {
			if(other.mask != null) {
				mask = other.mask;
			}
		} else if(other.mask != null) {
			mergedMask = getMaskLower().mask(other.getMaskLower());
		}
	}

	IPAddress getMaskLower() {
		if(mergedMask != null) {
			return mergedMask;
		}
		if(mask != null) {
			return mask.getValForMask();
		}
		return null;
	}
	
	Integer getEquivalentPrefixLength() {
		Integer pref = getNetworkPrefixLength();
		if(pref == null) {
			IPAddress mask = getMaskLower();
			if(mask != null) {
				pref = mask.getBlockMaskPrefixLength(true);
			}
		}
		return pref;
	}

	CharSequence getZone() {
		return zone;
	}

	Integer getNetworkPrefixLength() {
		return networkPrefixLength;
	}

	Integer getPort() {
		return port;
	}
	
	CharSequence getService() {
		return service;
	}
	
	IPVersion inferVersion(IPAddressStringParameters validationOptions) {
		if(networkPrefixLength != null) {
			if(networkPrefixLength > IPAddress.getBitCount(IPVersion.IPV4) && 
					!validationOptions.getIPv4Parameters().allowPrefixesBeyondAddressSize) {
				return IPVersion.IPV6;
			}
		} else if(mask != null) {
			if(mask.isProvidingIPv6()) {
				return IPVersion.IPV6;
			} else if(mask.isProvidingIPv4()) {
				return IPVersion.IPV4;
			}
		} 
		if (zone != null) {
			return IPVersion.IPV6;
		}
		return null;
	}

	@Override
	protected ParsedHostIdentifierStringQualifier clone() {
		try {
			return (ParsedHostIdentifierStringQualifier) super.clone();
		} catch (CloneNotSupportedException e) {
			return null;
		}
	}

	@Override
	public String toString() {
		return "network prefix length: " + networkPrefixLength +
				" mask: " + mask +
				" zone: " + zone + 
				" port: " + port + 
				" service: " + service;			
	}
}