/** * $RCSfile$ * $Revision$ * $Date$ * * Copyright (C) 2002-2003 Jive Software. All rights reserved. * ==================================================================== * The Jive Software License (based on Apache Software License, Version 1.1) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by * Jive Software (http://www.jivesoftware.com)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Smack" and "Jive Software" must not be used to * endorse or promote products derived from this software without * prior written permission. For written permission, please * contact webmaster@jivesoftware.com. * * 5. Products derived from this software may not be called "Smack", * nor may "Smack" appear in their name, without prior written * permission of Jive Software. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL JIVE SOFTWARE OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== */ package org.jivesoftware.smack; import org.xmlpull.v1.*; import java.util.*; import java.util.List; import java.io.ObjectInputStream; import java.io.ByteArrayInputStream; import java.net.URL; import java.beans.PropertyDescriptor; import org.jivesoftware.smack.packet.*; import org.jivesoftware.smack.packet.XMPPError; import org.jivesoftware.smack.filter.PacketFilter; import org.jivesoftware.smack.util.StringUtils; /** * Listens for XML traffic from the XMPP server and parses it into packet objects. * The packet reader also manages all packet listeners and collectors.

* * By default, this class only knows how to process IQ packets with query sub-packets that * are in a few namespaces:

* * Because many more IQ types are part of XMPP and its extensions, a pluggable IQ parsing * mechanism is provided. IQ providers are registered by creating a smack.providers file * in the WEB-INF directory of your JAR file. The file is an XML document that contains * one or more iqProvider entries, as in the following example: *
 * <?xml version="1.0"?>
 * <smackProviders>
 *     <iqProvider namespace="jabber:iq:time" className="org.jivesoftware.smack.packet.Time"/>
 * </smackProviders>
* * Each IQ provider is associated with a namespace. If multiple provider entries attempt to * register to handle the same namespace, the first entry loaded from the classpath will * take precendence. The IQ provider class can either implement the IQProvider interface, * or extend the IQ class. In the former case, each IQProvider is responsible for parsing * the raw XML stream to create an IQ instance. In the latter case, bean introspection is * used to try to automatically set properties of the IQ instance using the values found * in the IQ packet XML. For example, an XMPP time packet resembles the following: *
 * <iq type='get' to='joe@example.com' from='mary@example.com' id='time_1'>
 *     <query xmlns='jabber:iq:time'>
 *         <utc>20020910T17:58:35</utc>
 *         <tz>MDT</tz>
 *         <display>Tue Sep 10 12:58:35 2002</display>
 *     </query>
 * </iq>
* * In order for this packet to be automatically mapped to the Time object listed in the * providers file above, it must have the methods setUtc(String), setTz(String), and * setDisplay(tz). The introspection service will automatically try to convert the String * value from the XML into a boolean, int, long, float, double, or Class depending on the * type the IQ instance expects. * * @see PacketCollector * @see PacketListener * @author Matt Tucker */ class PacketReader { /** * Namespace used to store packet properties. */ private static final String PROPERTIES_NAMESPACE = "http://www.jivesoftware.com/xmlns/xmpp/properties"; private static Map iqProviders = new Hashtable(); static { // Load IQ processing providers. try { Enumeration enum = PacketReader.class.getClassLoader().getResources( "WEB-INF/smack.providers"); while (enum.hasMoreElements()) { URL url = (URL)enum.nextElement(); java.io.InputStream providerStream = null; try { providerStream = url.openStream(); XmlPullParser parser = getParserInstance(); parser.setInput(providerStream, "UTF-8"); int eventType = parser.getEventType(); do { if (eventType == XmlPullParser.START_TAG) { if (parser.getName().equals("iqProvider")) { String namespace = parser.getAttributeValue(0); // Only add the provider for the namespace if one isn't // already registered. if (!iqProviders.containsKey(namespace)) { String providerClass = parser.getAttributeValue(1); // Attempt to load the provider class and then create // a new instance if it's an IQProvider. Otherwise, if it's // an IQ class, add the class object itself, then we'll use // reflection later to create instances of the class. try { // Add the provider to the map. Class provider = Class.forName(providerClass); if (IQProvider.class.isAssignableFrom(provider)) { iqProviders.put(namespace, provider.newInstance()); } else if (IQ.class.isAssignableFrom(provider)) { iqProviders.put(namespace, provider); } } catch (ClassNotFoundException cnfe) { cnfe.printStackTrace(); } } } } eventType = parser.next(); } while (eventType != XmlPullParser.END_DOCUMENT); } finally { try { providerStream.close(); } catch (Exception e) { } } } } catch (Exception e) { } } private Thread readerThread; private Thread listenerThread; private XMPPConnection connection; private XmlPullParser parser; private boolean done = false; protected List collectors = new ArrayList(); private List listeners = new ArrayList(); private String connectionID = null; private Object connectionIDLock = new Object(); protected PacketReader(XMPPConnection connection) { this.connection = connection; readerThread = new Thread() { public void run() { parsePackets(); } }; readerThread.setName("Smack Packet Reader"); readerThread.setDaemon(true); listenerThread = new Thread() { public void run() { processListeners(); } }; listenerThread.setName("Smack Listener Processor"); listenerThread.setDaemon(true); try { parser = getParserInstance(); parser.setInput(connection.reader); } catch (XmlPullParserException xppe) { xppe.printStackTrace(); } } /** * Creates a new packet collector for this reader. A packet filter determines * which packets will be accumulated by the collector. * * @param packetFilter the packet filter to use. * @return a new packet collector. */ public PacketCollector createPacketCollector(PacketFilter packetFilter) { PacketCollector packetCollector = new PacketCollector(this, packetFilter); return packetCollector; } /** * Registers a packet listener with this reader. A packet filter determines * which packets will be delivered to the listener. * * @param packetListener the packet listener to notify of new packets. * @param packetFilter the packet filter to use. */ public void addPacketListener(PacketListener packetListener, PacketFilter packetFilter) { ListenerWrapper wrapper = new ListenerWrapper(this, packetListener, packetFilter); synchronized (listeners) { listeners.add(wrapper); } } /** * Removes a packet listener. * * @param packetListener the packet listener to remove. */ public void removePacketListener(PacketListener packetListener) { synchronized (listeners) { for (int i=0; i 0) { for (int i=listeners.size()-1; i>=0; i--) { if (listeners.get(i) == null) { listeners.remove(i); } } } } processedPacket = false; int size = listeners.size(); for (int i=0; i=0; i--) { if (collectors.get(i) == null) { collectors.remove(i); } } } // Loop through all collectors and notify the appropriate ones. int size = collectors.size(); for (int i=0; i