TCPConnectivity.java

/*
 * Copyright to the original author or authors.
 *
 * 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 org.rioproject.system.capability.connectivity;

import org.rioproject.deploy.SystemComponent;
import org.rioproject.net.HostUtil;

import java.net.*;
import java.util.Enumeration;

/**
 * The {@code TCPConnectivity} object provides definition for TCP/IP connectivity
 *
 * @author Dennis Reedy
 */
public class TCPConnectivity extends ConnectivityCapability {
    private static final long serialVersionUID = 1L;
    static final String DEFAULT_DESCRIPTION = "TCP/IP Connectivity";
    /** Number of NetworkInterfaces */
    public static final String IPv6_NIC = "IPv6 NICs";
    /** Number of NetworkInterfaces */
    public static final String IPv4_NIC = "IPv4 NICs";
    public static final String HOST_ADDRESS = "Address";
    public static final String HOST_NAME = "Host Name";
    public static final String ID = "Network";

    /** 
     * Create a TCPConnectivity 
     */
    public TCPConnectivity() throws SocketException, UnknownHostException {
        this(DEFAULT_DESCRIPTION);
    }

    /** 
     * Create a TCPConnectivity with a description
     *
     * @param description A description
     */
    public TCPConnectivity(final String description) throws SocketException, UnknownHostException {
        super(description==null?DEFAULT_DESCRIPTION:description);
        int ipv4Nics = 0;
        int ipv6Nics = 0;
        StringBuilder ipv4buff = new StringBuilder();
        StringBuilder ipv6buff = new StringBuilder();
        for(Enumeration en = NetworkInterface.getNetworkInterfaces();
            en.hasMoreElements();) {
            NetworkInterface nic = (NetworkInterface)en.nextElement();
            for(Enumeration en1=nic.getInetAddresses(); en1.hasMoreElements();) {
                InetAddress addr = (InetAddress)en1.nextElement();
                if(addr instanceof Inet6Address) {
                    if(ipv6Nics>0)
                        ipv6buff.append(", ");
                    ipv6buff.append(nic.getName());
                    ipv6Nics++;
                } else {
                    if(ipv4Nics>0)
                        ipv4buff.append(", ");
                    ipv4buff.append(nic.getName());
                    ipv4Nics++;
                }
            }
        }
        define(IPv4_NIC, ipv4buff.toString());
        if(ipv6Nics>0)
            define(IPv6_NIC, ipv6buff.toString());

        define(NAME, ID);
        define(HOST_ADDRESS, HostUtil.getInetAddress().getHostAddress());
        define(HOST_NAME, InetAddress.getLocalHost().getHostName());
    }

    /**
     * Override supports to ensure that requirements are supported
     *
     * @param requirement The requirement to test
     * @return True if they are, false if not
     *
     * @see org.rioproject.system.capability.PlatformCapability#supports
     */
    @Override
    public boolean supports(final SystemComponent requirement) {
        boolean supports = hasBasicSupport(requirement.getName(), requirement.getClassName());
        if(supports) {
            String hostAddress = (String) requirement.getAttributes().get(HOST_ADDRESS);
            String hostName = (String) requirement.getAttributes().get(HOST_NAME);

            /*if(requirement.exclude()) {
                if (hostAddress != null) {
                    supports = !hostAddress.equals(getValue(HOST_ADDRESS));
                } else {
                    supports = !hostName.equalsIgnoreCase((String) getValue(HOST_NAME));
                }
            } else {
                if (hostAddress != null) {
                    supports = hostAddress.equals(getValue(HOST_ADDRESS));
                } else {
                    supports = hostName.equalsIgnoreCase((String) getValue(HOST_NAME));
                }
            }*/
            if(hostAddress!=null) {
                supports = hostAddress.equals(getValue(HOST_ADDRESS));
            } else {
                supports = hostName.equalsIgnoreCase((String) getValue(HOST_NAME));
            }

        }
        return supports;
    }
}