com.aoindustries.aoserv.client.validator.MacAddress Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation
Java client for the AOServ Platform.
There is a newer version: 1.92.0
/*
 * aoserv-client - Java client for the AOServ platform.
 * Copyright (C) 2010-2013, 2016  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-client.
 *
 * aoserv-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoserv-client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoserv-client.  If not, see .
 */
package com.aoindustries.aoserv.client.validator;

import com.aoindustries.aoserv.client.DtoFactory;
import com.aoindustries.util.Internable;
import java.io.IOException;
import java.io.InvalidObjectException;
import java.io.ObjectInputStream;
import java.io.ObjectInputValidation;
import java.io.Serializable;
import java.util.Locale;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;

/**
 * Represents a 48-bit MAC address in HH:HH:HH:HH:HH:HH format.  Parses case insensitive, produces uppercase.
 *
 * {@link http://en.wikipedia.org/wiki/MAC_address}
 *
 * @author  AO Industries, Inc.
 */
final public class MacAddress implements
	Comparable,
	Serializable,
	ObjectInputValidation,
	DtoFactory,
	Internable
{

	private static final long serialVersionUID = 893218935616001329L;

	private static ValidationResult checkHexValue(char ch) {
		if(
			(ch<'0' || ch>'9')
			&& (ch<'A' || ch>'F')
			&& (ch<'a' || ch>'f')
		) return new InvalidResult(ApplicationResources.accessor, "MacAddress.checkHexValue.badCharacter", ch);
		return ValidResult.getInstance();
	}

	/**
	 * Checks if the address is valid.
	 */
	public static ValidationResult validate(String address) {
		// Be non-null
		if(address==null) return new InvalidResult(ApplicationResources.accessor, "MacAddress.validate.isNull");
		// Be non-empty
		int len = address.length();
		if(len!=17) return new InvalidResult(ApplicationResources.accessor, "MacAddress.parse.incorrectLength", len);
		ValidationResult result = checkHexValue(address.charAt(0));
		if(!result.isValid()) return result;
		result = checkHexValue(address.charAt(1));
		if(!result.isValid()) return result;
		if(address.charAt(2)!=':') return new InvalidResult(ApplicationResources.accessor, "MacAddress.parse.notColon", 2);
		result = checkHexValue(address.charAt(3));
		if(!result.isValid()) return result;
		result = checkHexValue(address.charAt(4));
		if(!result.isValid()) return result;
		if(address.charAt(5)!=':') return new InvalidResult(ApplicationResources.accessor, "MacAddress.parse.notColon", 5);
		result = checkHexValue(address.charAt(6));
		if(!result.isValid()) return result;
		result = checkHexValue(address.charAt(7));
		if(!result.isValid()) return result;
		if(address.charAt(8)!=':') return new InvalidResult(ApplicationResources.accessor, "MacAddress.parse.notColon", 8);
		result = checkHexValue(address.charAt(9));
		if(!result.isValid()) return result;
		result = checkHexValue(address.charAt(10));
		if(!result.isValid()) return result;
		if(address.charAt(11)!=':') return new InvalidResult(ApplicationResources.accessor, "MacAddress.parse.notColon", 11);
		result = checkHexValue(address.charAt(12));
		if(!result.isValid()) return result;
		result = checkHexValue(address.charAt(13));
		if(!result.isValid()) return result;
		if(address.charAt(14)!=':') return new InvalidResult(ApplicationResources.accessor, "MacAddress.parse.notColon", 14);
		result = checkHexValue(address.charAt(15));
		if(!result.isValid()) return result;
		result = checkHexValue(address.charAt(16));
		if(!result.isValid()) return result;
		return ValidResult.getInstance();
	}

	private static final ConcurrentMap interned = new ConcurrentHashMap<>();

	public static MacAddress valueOf(String address) throws ValidationException {
		//MacAddress existing = interned.get(address);
		//return existing!=null ? existing : new MacAddress(address);
		return new MacAddress(address);
	}

	final private String address;

	private MacAddress(String address) throws ValidationException {
		this.address = address.toUpperCase(Locale.ROOT);
		validate();
	}

	private void validate() throws ValidationException {
		ValidationResult result = validate(address);
		if(!result.isValid()) throw new ValidationException(result);
	}

	/**
	 * Perform same validation as constructor on readObject.
	 */
	private void readObject(ObjectInputStream ois) throws ClassNotFoundException, IOException {
		ois.defaultReadObject();
		validateObject();
	}

	@Override
	public void validateObject() throws InvalidObjectException {
		try {
			validate();
		} catch(ValidationException err) {
			InvalidObjectException newErr = new InvalidObjectException(err.getMessage());
			newErr.initCause(err);
			throw newErr;
		}
	}

	@Override
	public boolean equals(Object O) {
		return
			(O instanceof MacAddress)
			&& address.equals(((MacAddress)O).address)
		;
	}

	@Override
	public int hashCode() {
		return address.hashCode();
	}

	@Override
	public int compareTo(MacAddress other) {
		return this==other ? 0 : address.compareTo(other.address);
	}

	@Override
	public String toString() {
		return address;
	}

	/**
	 * Interns this IP much in the same fashion as String.intern().
	 *
	 * @see  String#intern()
	 */
	@Override
	public MacAddress intern() {
		try {
			MacAddress existing = interned.get(address);
			if(existing==null) {
				String internedAddress = address.intern();
				MacAddress addMe = address==internedAddress ? this : new MacAddress(internedAddress);
				existing = interned.putIfAbsent(internedAddress, addMe);
				if(existing==null) existing = addMe;
			}
			return existing;
		} catch(ValidationException err) {
			// Should not fail validation since original object passed
			throw new AssertionError(err.getMessage());
		}
	}

	@Override
	public com.aoindustries.aoserv.client.dto.MacAddress getDto() {
		return new com.aoindustries.aoserv.client.dto.MacAddress(address);
	}

	public boolean isBroadcast() {
		return address.equals("FF:FF:FF:FF:FF:FF");
	}
}