/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.

 *

 * This code 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 General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 */

/* @test

 * @bug 4527345

 * @summary Unit test for DatagramChannel's multicast support

 * @build BasicMulticastTests NetworkConfiguration

 * @run main BasicMulticastTests

 */

import java.nio.ByteBuffer;

import java.nio.channels.*;

import java.net.*;

import java.util.*;

import java.io.IOException;

public class BasicMulticastTests {

    /**

     * Tests that existing membership key is returned by join methods and that

     * membership key methods return the expected results

     */

    static void membershipKeyTests(NetworkInterface nif,

                                   InetAddress group,

                                   InetAddress source)

        throws IOException

    {

        System.out.format("MembershipKey test using %s @ %s\n",

            group.getHostAddress(), nif.getName());

        ProtocolFamily family = (group instanceof Inet4Address) ?

            StandardProtocolFamily.INET : StandardProtocolFamily.INET6;

        DatagramChannel dc = DatagramChannel.open(family)

            .setOption(StandardSocketOption.SO_REUSEADDR, true)

            .bind(new InetSocketAddress(source, 0));

        // check existing key is returned

        MembershipKey key = dc.join(group, nif);

        MembershipKey other = dc.join(group, nif);

        if (other != key) {

            throw new RuntimeException("existing key not returned");

        }

        // check key

        if (!key.isValid())

            throw new RuntimeException("key is not valid");

        if (!key.group().equals(group))

            throw new RuntimeException("group is incorrect");

        if (!key.networkInterface().equals(nif))

            throw new RuntimeException("network interface is incorrect");

        if (key.sourceAddress() != null)

            throw new RuntimeException("key is source specific");

        // drop membership

        key.drop();

        if (key.isValid()) {

            throw new RuntimeException("key is still valid");

        }

        // source-specific

        try {

            key = dc.join(group, nif, source);

            other = dc.join(group, nif, source);

            if (other != key) {

                throw new RuntimeException("existing key not returned");

            }

            if (!key.isValid())

                throw new RuntimeException("key is not valid");

            if (!key.group().equals(group))

                throw new RuntimeException("group is incorrect");

            if (!key.networkInterface().equals(nif))

                throw new RuntimeException("network interface is incorrect");

            if (!key.sourceAddress().equals(source))

                throw new RuntimeException("key's source address incorrect");

            // drop membership

            key.drop();

            if (key.isValid()) {

                throw new RuntimeException("key is still valid");

            }

        } catch (UnsupportedOperationException x) {

        }

        // done

        dc.close();

    }

    /**

     * Tests exceptions for invalid arguments or scenarios

     */

    static void exceptionTests(NetworkInterface nif)

        throws IOException

    {

        System.out.println("Exception Tests");

        DatagramChannel dc = DatagramChannel.open(StandardProtocolFamily.INET)

            .setOption(StandardSocketOption.SO_REUSEADDR, true)

            .bind(new InetSocketAddress(0));

        InetAddress group = InetAddress.getByName("225.4.5.6");

        InetAddress notGroup = InetAddress.getByName("1.2.3.4");

        InetAddress thisHost = InetAddress.getLocalHost();

        // IllegalStateException

        MembershipKey key;

        key = dc.join(group, nif);

        try {

            dc.join(group, nif, thisHost);

            throw new RuntimeException("IllegalStateException not thrown");

        } catch (IllegalStateException x) {

        } catch (UnsupportedOperationException x) {

        }

        key.drop();

        try {

            key = dc.join(group, nif, thisHost);

            try {

                dc.join(group, nif);

                throw new RuntimeException("IllegalStateException not thrown");

            } catch (IllegalStateException x) {

            }

            key.drop();

        } catch (UnsupportedOperationException x) {

        }

        // IllegalArgumentException

        try {

            dc.join(notGroup, nif);

            throw new RuntimeException("IllegalArgumentException not thrown");

        } catch (IllegalArgumentException x) {

        }

        try {

            dc.join(notGroup, nif, thisHost);

            throw new RuntimeException("IllegalArgumentException not thrown");

        } catch (IllegalArgumentException x) {

        } catch (UnsupportedOperationException x) {

        }

        // NullPointerException

        try {

            dc.join(null, nif);

            throw new RuntimeException("NullPointerException not thrown");

        } catch (NullPointerException x) {

        }

        try {

            dc.join(group, null);

            throw new RuntimeException("NullPointerException not thrown");

        } catch (NullPointerException x) {

        }

        try {

            dc.join(group, nif, null);

            throw new RuntimeException("NullPointerException not thrown");

        } catch (NullPointerException x) {

        } catch (UnsupportedOperationException x) {

        }

        dc.close();

        // ClosedChannelException

        try {

            dc.join(group, nif);

            throw new RuntimeException("ClosedChannelException not thrown");

        } catch (ClosedChannelException x) {

        }

        try {

            dc.join(group, nif, thisHost);

            throw new RuntimeException("ClosedChannelException not thrown");

        } catch (ClosedChannelException x) {

        } catch (UnsupportedOperationException x) {

        }

    }

    /**

     * Probe interfaces to get interfaces that support IPv4 or IPv6 multicasting

     * and invoke tests.

     */

    public static void main(String[] args) throws IOException {

        // multicast groups used for the test

        InetAddress ip4Group = InetAddress.getByName("225.4.5.6");

        InetAddress ip6Group = InetAddress.getByName("ff02::a");

        NetworkConfiguration config = NetworkConfiguration.probe();

        NetworkInterface nif = config.ip4Interfaces().iterator().next();

        InetAddress anySource = config.ip4Addresses(nif).iterator().next();

        membershipKeyTests(nif, ip4Group, anySource);

        exceptionTests(nif);

        // re-run the membership key tests with IPv6 if available

        Iterator<NetworkInterface> iter = config.ip6Interfaces().iterator();

        if (iter.hasNext()) {

            nif = iter.next();

            anySource = config.ip6Addresses(nif).iterator().next();

            membershipKeyTests(nif, ip6Group, anySource);

        }

    }

}