/*
 * 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.catalina.tribes.group;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Comparator;
import java.util.List;

import org.apache.catalina.tribes.Member;

/**
 * <p>
 * Title: Membership - Absolute Order
 * </p>
 * <p>
 * Description: A simple, yet agreeable and efficient way of ordering members
 * </p>
 * <p>
 * Ordering members can serve as a basis for electing a leader or coordinating efforts.<br>
 * This is stinky simple, it works on the basis of the <code>Member</code> interface and orders members in the following
 * format:
 * </p>
 * <ol>
 * <li>IP comparison - byte by byte, lower byte higher rank</li>
 * <li>IPv4 addresses rank higher than IPv6, ie the lesser number of bytes, the higher rank</li>
 * <li>Port comparison - lower port, higher rank</li>
 * <li>UniqueId comparison- byte by byte, lower byte higher rank</li>
 * </ol>
 *
 * @see org.apache.catalina.tribes.Member
 */
public class AbsoluteOrder {
    /**
     * The comparator for absolute order.
     */
    public static final AbsoluteComparator comp = new AbsoluteComparator();

    /**
     * Protected constructor.
     */
    protected AbsoluteOrder() {
        super();
    }


    /**
     * Sort the members in absolute order.
     *
     * @param members The members to sort
     */
    public static void absoluteOrder(Member[] members) {
        if (members == null || members.length <= 1) {
            return;
        }
        Arrays.sort(members, comp);
    }

    /**
     * Sort the members in absolute order.
     *
     * @param members The members to sort
     */
    public static void absoluteOrder(List<Member> members) {
        if (members == null || members.size() <= 1) {
            return;
        }
        members.sort(comp);
    }

    /**
     * A comparator for absolute ordering of members.
     */
    public static class AbsoluteComparator implements Comparator<Member>, Serializable {

        private static final long serialVersionUID = 1L;

        /**
         * Default constructor.
         */
        public AbsoluteComparator() {
        }

        @Override
        public int compare(Member m1, Member m2) {
            int result = compareIps(m1, m2);
            if (result == 0) {
                result = comparePorts(m1, m2);
            }
            if (result == 0) {
                result = compareIds(m1, m2);
            }
            return result;
        }

        /**
         * Compare the IP addresses of two members.
         *
         * @param m1 First member
         * @param m2 Second member
         * @return comparison result
         */
        public int compareIps(Member m1, Member m2) {
            return compareBytes(m1.getHost(), m2.getHost());
        }

        /**
         * Compare the ports of two members.
         *
         * @param m1 First member
         * @param m2 Second member
         * @return comparison result
         */
        public int comparePorts(Member m1, Member m2) {
            return compareInts(m1.getPort(), m2.getPort());
        }

        /**
         * Compare the unique IDs of two members.
         *
         * @param m1 First member
         * @param m2 Second member
         * @return comparison result
         */
        public int compareIds(Member m1, Member m2) {
            return compareBytes(m1.getUniqueId(), m2.getUniqueId());
        }

        /**
         * Compare two byte arrays.
         *
         * @param d1 First byte array
         * @param d2 Second byte array
         * @return comparison result
         */
        protected int compareBytes(byte[] d1, byte[] d2) {
            int result = 0;
            if (d1.length == d2.length) {
                for (int i = 0; (result == 0) && (i < d1.length); i++) {
                    result = compareBytes(d1[i], d2[i]);
                }
            } else if (d1.length < d2.length) {
                result = -1;
            } else {
                result = 1;
            }
            return result;
        }

        /**
         * Compare two bytes.
         *
         * @param b1 First byte
         * @param b2 Second byte
         * @return comparison result
         */
        protected int compareBytes(byte b1, byte b2) {
            return compareInts(b1 & 0xFF, b2 & 0xFF);
        }

        /**
         * Compare two integers.
         *
         * @param b1 First integer
         * @param b2 Second integer
         * @return comparison result
         */
        protected int compareInts(int b1, int b2) {
            return Integer.compare(b1, b2);
        }
    }

}
