/*
* JBoss, Home of Professional Open Source.
* Copyright 2012, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This 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 2.1 of
* the License, or (at your option) any later version.
*
* This software 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 this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
/**
*
*/
package org.jboss.as.controller.interfaces;
import static org.jboss.as.controller.logging.ControllerLogger.MGMT_OP_LOGGER;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ANY_ADDRESS;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.INET_ADDRESS;
import java.net.Inet6Address;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.SocketException;
import java.net.UnknownHostException;
import java.util.Collections;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import org.jboss.as.controller.logging.ControllerLogger;
import org.wildfly.common.Assert;
/**
* {@link InterfaceCriteria} that tests whether a given address is matches
* the specified address.
*
* @author Brian Stansberry
*/
public class InetAddressMatchInterfaceCriteria extends AbstractInterfaceCriteria {
private static final long serialVersionUID = 149404752878332750L;
private String address;
private InetAddress resolved;
private boolean unknownHostLogged;
private boolean anyLocalLogged;
public InetAddressMatchInterfaceCriteria(final InetAddress address) {
Assert.checkNotNullParam("address", address);
this.resolved = address;
this.address = resolved.getHostAddress();
}
/**
* Creates a new InetAddressMatchInterfaceCriteria
*
* @param address a valid String value to pass to {@link InetAddress#getByName(String)}
* Cannot be {@code null}
*
* @throws IllegalArgumentException if <code>network</code> is <code>null</code>
*/
public InetAddressMatchInterfaceCriteria(final String address) {
Assert.checkNotNullParam("address", address);
Assert.checkNotEmptyParam("address", address.trim());
this.address = address;
}
public synchronized InetAddress getAddress() throws UnknownHostException {
if (resolved == null) {
resolved = InetAddress.getByName(address);
}
return this.resolved;
}
@Override
public Map<NetworkInterface, Set<InetAddress>> getAcceptableAddresses(Map<NetworkInterface, Set<InetAddress>> candidates) throws SocketException {
Map<NetworkInterface, Set<InetAddress>> result = super.getAcceptableAddresses(candidates);
// AS7-4509 Validate we only have a single match
Map<NetworkInterface, Set<InetAddress>> pruned = result.size() > 1 ? OverallInterfaceCriteria.pruneAliasDuplicates(result) : result;
if (pruned.size() > 1 || (pruned.size() == 1 && pruned.values().iterator().next().size() > 1)) {
logMultipleValidInterfaces(pruned);
result = Collections.emptyMap();
}
return result;
}
/**
* {@inheritDoc}
*
* @return <code>getAddress()</code> if the <code>address</code> is the same as the one returned by {@link #getAddress()}.
*/
@Override
protected InetAddress isAcceptable(NetworkInterface networkInterface, InetAddress address) throws SocketException {
try {
InetAddress toMatch = getAddress();
// One time only warn against use of wildcard addresses
if (!anyLocalLogged && toMatch.isAnyLocalAddress()) {
MGMT_OP_LOGGER.invalidWildcardAddress(this.address, INET_ADDRESS, ANY_ADDRESS);
anyLocalLogged = true;
}
if( toMatch.equals(address) ) {
if (toMatch instanceof Inet6Address) {
return matchIPv6((Inet6Address) toMatch, (Inet6Address) address);
}
return toMatch;
}
} catch (UnknownHostException e) {
// One time only log a warning
if (!unknownHostLogged) {
MGMT_OP_LOGGER.cannotResolveAddress(this.address);
unknownHostLogged = true;
}
return null;
}
return null;
}
public String toString() {
StringBuilder sb = new StringBuilder("InetAddressMatchInterfaceCriteria(");
sb.append("address=");
sb.append(address);
sb.append(",resolved=");
sb.append(resolved);
sb.append(')');
return sb.toString();
}
private static InetAddress matchIPv6(Inet6Address toMatch, Inet6Address address) {
// No specified scope always matches; specified scope must match
return (toMatch.getScopeId() == 0 || toMatch.getScopeId() == address.getScopeId()) ? address : null;
}
@Override
public int hashCode() {
return address.hashCode();
}
@Override
public boolean equals(Object o) {
if (o instanceof InetAddressMatchInterfaceCriteria) {
if (address != null) {
return address.equals(((InetAddressMatchInterfaceCriteria)o).address);
}
}
return false;
}
private void logMultipleValidInterfaces(Map<NetworkInterface, Set<InetAddress>> matches) {
Set<String> nis = new HashSet<String>();
Set<InetAddress> addresses = new HashSet<InetAddress>();
for (Map.Entry<NetworkInterface, Set<InetAddress>> entry : matches.entrySet()) {
nis.add(entry.getKey().getName());
addresses.addAll(entry.getValue());
}
String toMatch = resolved != null ? resolved.getHostAddress() : address;
ControllerLogger.ROOT_LOGGER.multipleMatchingAddresses(toMatch, addresses, nis);
}
}