Allow providers to be set through API. Load providers file from META-INF instead of WEB-INF.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@1991 b35dd754-fafc-0310-a699-88a17e54d16e

source/org/jivesoftware/smack/provider/ProviderManager.java

@@ -68,16 +68,16 @@ import java.net.URL;
  *
  * <b>IQProvider</b><p>
  *
- * By default, Smack only knows how to process IQ packets with query sub-packets that
+ * By default, Smack only knows how to process IQ packets with sub-packets that
- * are in a few namespaces:<ul>
+ * are in a few namespaces such as:<ul>
  *      <li>jabber:iq:auth
  *      <li>jabber:iq:roster
  *      <li>jabber:iq:register</ul>
  *
  * 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
+ * mechanism is provided. IQ providers are registered programatically or by creating a
- * in the WEB-INF directory of your JAR file. The file is an XML document that contains
+ * smack.providers file in the META-INF directory of your JAR file. The file is an XML
- * one or more iqProvider entries, as in the following example:
+ * document that contains one or more iqProvider entries, as in the following example:
  *
  * <pre>
  * &lt;?xml version="1.0"?&gt;
@@ -89,12 +89,12 @@ import java.net.URL;
  *     &lt;/iqProvider&gt;
  * &lt;/smackProviders&gt;</pre>
  *
- * Each IQ provider is associated with an element name and a namespace. If multiple provider entries attempt to
+ * Each IQ provider is associated with an element name and a namespace. If multiple provider
- * register to handle the same namespace, the first entry loaded from the classpath will
+ * entries attempt to register to handle the same namespace, the first entry loaded from the
- * take precedence. The IQ provider class can either implement the IQProvider interface,
+ * classpath will take precedence. The IQ provider class can either implement the IQProvider
- * or extend the IQ class. In the former case, each IQProvider is responsible for parsing
+ * interface, or extend the IQ class. In the former case, each IQProvider is responsible for
- * the raw XML stream to create an IQ instance. In the latter case, bean introspection is
+ * parsing the raw XML stream to create an IQ instance. In the latter case, bean introspection
- * used to try to automatically set properties of the IQ instance using the values found
+ * 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:
  * <pre>
  * &lt;iq type='result' to='joe@example.com' from='mary@example.com' id='time_1'&gt;
@@ -147,7 +147,7 @@ public class ProviderManager {
         // Load IQ processing providers.
         try {
             Enumeration enum = ProviderManager.class.getClassLoader().getResources(
-                    "WEB-INF/smack.providers");
+                    "META-INF/smack.providers");
             while (enum.hasMoreElements()) {
                 URL url = (URL)enum.nextElement();
                 java.io.InputStream providerStream = null;
@@ -266,6 +266,21 @@ public class ProviderManager {
         return iqProviders.get(key);
     }
 
+    /**
+     * Adds an IQ provider with the specified element name and name space. The provider
+     * will override any providers loaded through the classpath.
+     *
+     * @param elementName the XML element name.
+     * @param namespace the XML namespace.
+     * @param provider the IQ provider.
+     */
+    public synchronized static void addIQProvider(String elementName, String namespace,
+            IQProvider provider)
+    {
+        String key = getProviderKey(elementName, namespace);
+        iqProviders.put(key, provider);
+    }
+
     /**
      * Returns the packet extension provider registered to the specified XML element name
      * and namespace. For example, if a provider was registered to the element name "x" and the
@@ -290,6 +305,26 @@ public class ProviderManager {
         return extensionProviders.get(key);
     }
 
+    /**
+     * Adds an extension provider with the specified element name and name space. The provider
+     * will override any providers loaded through the classpath. The provider must be either
+     * a PacketExtensionProvider instance, or a Class object of a Javabean.
+     *
+     * @param elementName the XML element name.
+     * @param namespace the XML namespace.
+     * @param provider the extension provider.
+     */
+    public synchronized static void addExtensionProvider(String elementName, String namespace,
+            Object provider)
+    {
+        if (!(provider instanceof PacketExtensionProvider || provider instanceof Class)) {
+            throw new IllegalArgumentException("Provider must be a PacketExtensionProvider " +
+                    "or a Class instance.");
+        }
+        String key = getProviderKey(elementName, namespace);
+        extensionProviders.put(key, provider);
+    }
+
     /**
      * Returns a String key for a given element name and namespace.
      *