trunk/src/java/org/apache/lenya/ac/Machine.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You 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.apache.lenya.ac;

import java.io.Serializable;
import java.net.InetAddress;
import java.net.UnknownHostException;
import java.util.ArrayList;
import java.util.List;

/**
 * A machine (representing an IP address).
 * @version $Id$
 */
public class Machine implements Identifiable, Serializable {

    /**
	 * 
	 */
	private static final long serialVersionUID = 1L;

	/**
     * Creates a new machine object. This method accepts
     * numeric IPv4 addresses like <code>"129.168.0.32"</code>,
     * numeric IPv6 addresses like <code>"1080::8:800:200C:417A"</code>
     * as well as hostnames (if DNS resolution is available) like
     * <code>"localhost"</code> or <code>"www.apache.com"</code>.
     * 
     * @param ip a <code>String</code> like <code>"192.168.0.32"</code>,
     *      <code>"::1"</code>, ...
     * .
     * @throws AccessControlException when the conversion of the
     *      <code>String</code> to an <code>InetAddress</code> failed
     */
    public Machine(String ip) throws AccessControlException {
        try {
            setAddress(InetAddress.getByName(ip));
        } catch(UnknownHostException uhe) {
            throw new AccessControlException
                ("Failed to convert address [" + ip + "]: ", uhe);
        }
    }

    private InetAddress address;

    /**
     * @see java.lang.Object#equals(Object)
     */
    public boolean equals(Object otherObject) {
        boolean equals = false;

        if (otherObject instanceof Machine) {
            Machine otherMachine = (Machine) otherObject;
            equals = getAddress().equals(otherMachine.getAddress());
        }

        return equals;
    }

    /**
     * @see java.lang.Object#hashCode()
     */
    public int hashCode() {
        return getAddress().hashCode();
    }

    /**
     * @see org.apache.lenya.ac.Accreditable#getAccreditables()
     */
    public Accreditable[] getAccreditables() {
        Accreditable[] ranges = getIPRanges();
        Accreditable[] accreditables = new Accreditable[ranges.length + 1];
        accreditables[0] = this;
        for (int i = 0; i < ranges.length; i++) {
            accreditables[i+1] = ranges[i];
        }
        return accreditables;
    }

    /**
     * Returns the IP address.
     * @return The IP address.
     */
    public String getIp() {
        return getAddress().getHostAddress();
    }

    /**
     * Converts a string to an IP addres.
     * @param string The IP address, represented by a string.
     * @return An InetAddress object.
     * @throws AccessControlException when something went wrong.
     * @deprecated This method is unnecessary and does not work for IPv6.
     *      Use <code>InetAddress.getByName(string)</code> instead!
     */
    public static InetAddress getAddress(String string)
        throws AccessControlException {
        String[] strings = string.split("\\.");

        InetAddress address;
        try {
            byte[] numbers = new byte[strings.length];
            for (int i = 0; i < strings.length; i++) {
                int number = Integer.parseInt(strings[i]);
                if (number > 127) {
                    number = number - 256;
                }
                numbers[i] = (byte) number;
            }

            address = InetAddress.getByAddress(numbers);
        } catch (final NumberFormatException e1) {
            throw new AccessControlException(
                    "Failed to convert address [" + string + "]: ",
                    e1);
        } catch (final UnknownHostException e1) {
            throw new AccessControlException(
                    "Failed to convert address [" + string + "]: ",
                    e1);
        }
        return address;
    }

    /**
     * @see java.lang.Object#toString()
     */
    public String toString() {
        return getIp();
    }

    /**
     * Returns the IP address.
     * @return An IP address.
     */
    public InetAddress getAddress() {
        return this.address;
    }

    /**
     * Sets the IP address.
     * @param _address An IP address.
     */
    public void setAddress(InetAddress _address) {
        this.address = _address;
    }

    private List ipRanges = new ArrayList();
    
    /**
     * Adds an IP range to this machine.
     * @param range An IP range this machine belongs to.
     */
    public void addIPRange(IPRange range) {
        assert range != null;
        assert !this.ipRanges.contains(range);
        this.ipRanges.add(range);
    }
    
    /**
     * Returns the IP ranges this machine belongs to.
     * @return An array of IP ranges.
     */
    public IPRange[] getIPRanges() {
        return (IPRange[]) this.ipRanges.toArray(new IPRange[this.ipRanges.size()]);
    }
    
}