Reworked OSGi support of Smack (SMACK-343)

Because of OSGi, no subproject of Smack (which is the same as a OSGi
bundle) must export a package that is already exported by another
subproject.

Therefore it was necessary to move the TCP and BOSH code into their own
packages: org.jivesoftware.smack.(tcp|bosh).

OSGi classloader restrictions also made it necessary to create a
Declarative Service for smack-extensions, smack-experimental and
smack-lagacy (i.e. smack subprojects which should be initialized), in
order to initialize them accordingly, as smack-core is, when used in a
OSGi environment, unable to load and initialize classes from other smack
bundles. OSGi's "Service Component Runtime" (SCR) will now take care of
running the initialization code of the particular Smack bundle by
activating its Declarative Service.

That is also the reason why most initialization related method now have an
additional classloader argument.

Note that due the refactoring, some ugly changes in XMPPTCPConnection
and its PacketReader and PacketWriter where necessary.

smack-tcp/src/test/java/org/jivesoftware/smack/tcp/PacketWriterTest.java

@@ -0,0 +1,118 @@
+/**
+ *
+ * Copyright 2014 Florian Schmaus
+ *
+ * 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.jivesoftware.smack.tcp;
+
+import java.io.IOException;
+import java.io.Writer;
+import java.util.concurrent.BrokenBarrierException;
+import java.util.concurrent.CyclicBarrier;
+
+import org.jivesoftware.smack.SmackException.NotConnectedException;
+import org.jivesoftware.smack.packet.Message;
+import org.junit.Test;
+
+import static org.junit.Assert.fail;
+
+public class PacketWriterTest {
+    volatile boolean shutdown;
+    volatile boolean prematureUnblocked;
+
+    /**
+     * Make sure that packet writer does block once the queue reaches
+     * {@link PacketWriter#QUEUE_SIZE} and that
+     * {@link PacketWriter#sendPacket(org.jivesoftware.smack.tcp.packet.Packet)} does unblock after the
+     * interrupt.
+     * 
+     * @throws InterruptedException
+     * @throws BrokenBarrierException
+     */
+    @SuppressWarnings("javadoc")
+    @Test
+    public void shouldBlockAndUnblockTest() throws InterruptedException, BrokenBarrierException, NotConnectedException {
+        XMPPTCPConnection connection = new XMPPTCPConnection("foobar.com");
+        final PacketWriter pw = new PacketWriter(connection);
+        pw.setWriter(new BlockingStringWriter());
+        pw.startup();
+
+        for (int i = 0; i < PacketWriter.QUEUE_SIZE; i++) {
+            pw.sendPacket(new Message());
+        }
+        
+        final CyclicBarrier barrier = new CyclicBarrier(2);
+        shutdown = false;
+        prematureUnblocked = false;
+        Thread t = new Thread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    barrier.await();
+                    pw.sendPacket(new Message());
+                    // should only return after the pw was interrupted
+                    if (!shutdown) {
+                        prematureUnblocked = true;
+                    }
+                }
+                catch (Exception e) {
+                }
+                try {
+                    barrier.await();
+                }
+                catch (InterruptedException | BrokenBarrierException e) {
+                }
+            }
+        });
+        t.start();
+        // This barrier is not strictly necessary, but may increases the chances that the threat
+        // will block before we call shutdown. Otherwise we may get false positives (which is still
+        // better then false negatives).
+        barrier.await();
+        // Not really cool, but may increases the chances for 't' to block in sendPacket.
+        Thread.sleep(250);
+
+        // Set to true for testing purposes, so that shutdown() won't wait packet writer
+        pw.shutdownDone.set(true);
+        // Shutdown the packetwriter
+        pw.shutdown();
+        shutdown = true;
+        barrier.await();
+        if (prematureUnblocked) {
+            fail("Should not unblock before the thread got shutdown");
+        }
+        synchronized (t) {
+            t.notify();
+        }
+    }
+    
+    public class BlockingStringWriter extends Writer {
+        @Override
+        public void write(char[] cbuf, int off, int len) throws IOException {
+            try {
+                wait();
+            }
+            catch (InterruptedException e) {
+            }
+        }
+
+        @Override
+        public void flush() throws IOException {
+        }
+
+        @Override
+        public void close() throws IOException {
+        }
+    }
+}

smack-tcp/src/test/java/org/jivesoftware/smack/tcp/RosterOfflineTest.java

@@ -0,0 +1,63 @@
+/**
+ *
+ * Copyright 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.jivesoftware.smack.tcp;
+
+import static org.junit.Assert.*;
+
+import org.jivesoftware.smack.Roster;
+import org.jivesoftware.smack.SmackException;
+import org.jivesoftware.smack.XMPPConnection;
+import org.jivesoftware.smack.XMPPException;
+import org.junit.Before;
+import org.junit.Test;
+
+/**
+ * Tests the behavior of the roster if the connection is not authenticated yet.
+ * 
+ * @author Henning Staib
+ */
+public class RosterOfflineTest {
+
+    XMPPConnection connection;
+
+    Roster roster;
+
+    @Before
+    public void setup() throws XMPPException, SmackException {
+        this.connection = new XMPPTCPConnection("localhost");
+        assertFalse(connection.isConnected());
+
+        roster = connection.getRoster();
+        assertNotNull(roster);
+    }
+
+    @Test(expected = SmackException.class)
+    public void shouldThrowExceptionOnCreateEntry() throws Exception {
+        roster.createEntry("test", "test", null);
+    }
+
+    @Test(expected = SmackException.class)
+    public void shouldThrowExceptionOnReload() throws Exception {
+        roster.reload();
+    }
+
+    @Test(expected = SmackException.class)
+    public void shouldThrowExceptionRemoveEntry() throws Exception {
+        roster.removeEntry(null);
+    }
+
+}