2003-06-19 20:15:28 +02:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>Smack: Provider Architecture - Jive Software</title>
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="style.css" />
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div class="header">
|
|
|
|
|
Provider Architecture: Packet Extensions and Custom IQ's
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="nav">
|
|
|
|
|
« <a href="index.html">Table of Contents</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<p>
|
2014-01-16 06:14:39 +01:00
|
|
|
<p class="subheader">Introduction</p>
|
2003-06-19 20:15:28 +02:00
|
|
|
|
2003-10-13 19:34:45 +02:00
|
|
|
The Smack provider architecture is a system for plugging in
|
|
|
|
|
custom XML parsing of packet extensions and IQ packets. The
|
|
|
|
|
standard <a href="extensions/index.html">Smack Extensions</a>
|
2014-01-16 06:14:39 +01:00
|
|
|
are built using the provider architecture. There are two types of
|
|
|
|
|
providers:<ul>
|
2003-10-13 19:34:45 +02:00
|
|
|
<li><tt>IQProvider</tt> -- parses IQ requests into Java objects.
|
2014-01-16 06:14:39 +01:00
|
|
|
<li><tt>Extension Provider</tt> -- parses XML sub-documents attached to
|
2003-10-13 19:34:45 +02:00
|
|
|
packets into PacketExtension instances.</ul>
|
|
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
By default, Smack only knows how to process a few standard packets and sub-packets
|
|
|
|
|
that are in a few namespaces such as:<ul>
|
2003-10-13 19:34:45 +02:00
|
|
|
<li>jabber:iq:auth
|
|
|
|
|
<li>jabber:iq:roster
|
|
|
|
|
<li>jabber:iq:register</ul>
|
|
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
There are many more IQ types and extensions that are part of XMPP standards, and of
|
|
|
|
|
course an endless number that can be added as custom extensions. To support this, an
|
|
|
|
|
extensible parsing mechanism is provided via Smack and user build providers.
|
|
|
|
|
<p>
|
|
|
|
|
Whenever a packet extension is found in a packet, parsing will
|
|
|
|
|
be passed to the correct provider. Each provider can either implement the
|
|
|
|
|
PacketExtensionProvider interface or be a standard Java Bean. In the
|
|
|
|
|
former case, each extension provider is responsible for parsing the raw
|
|
|
|
|
XML stream, via the <a href="http://www.xmlpull.org/">XML Pull Parser</a>, to contruct an object. In the latter case, bean introspection
|
|
|
|
|
is used to try to automatically set the properties of the class using
|
|
|
|
|
the values in the packet extension sub-element.
|
|
|
|
|
<p>
|
|
|
|
|
When no extension provider is registered for an element name and
|
|
|
|
|
namespace combination, Smack will store all top-level elements of the
|
|
|
|
|
sub-packet in the DefaultPacketExtension object and then attach it to the packet.
|
2003-10-13 19:34:45 +02:00
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
<p>
|
|
|
|
|
Management of these providers is accomplished via the <a href="">ProviderManager</a>
|
|
|
|
|
class. There are multiple ways to add providers to the manager.<ul>
|
|
|
|
|
<li>Call addXXProvider methods - You can call the appropriate add methods directly.
|
2003-10-13 19:34:45 +02:00
|
|
|
<pre>
|
2014-01-16 06:14:39 +01:00
|
|
|
ProviderManager.getInstance().addIQProvider("element", "namespace", new MyIQProvider());
|
|
|
|
|
ProviderManager.getInstance().addExtensionProvider("element", "namespace", new MyExtProvider());
|
|
|
|
|
</pre>
|
|
|
|
|
<li>Add a loader - You can add a ProviderLoader which will inject a means of loading multiple
|
|
|
|
|
providers (both types) into the manager. This is the mechanism used by Smack to load from the
|
|
|
|
|
Smack specific file format (via ProviderFileLoader). Implementers can provide the means to load
|
|
|
|
|
providers from any source they wish, or simply reuse the ProviderFileLoader to load from
|
|
|
|
|
their own provider files.
|
|
|
|
|
<pre>
|
|
|
|
|
ProviderManager.getInstance().addLoader(new ProviderFileLoader(FileUtils.getStreamForUrl("classpath:com/myco/provider/myco_custom.providers", null)));
|
|
|
|
|
</pre>
|
|
|
|
|
<li>VM Argument - You can add a provider file via the VM argument <i>smack.provider.file</i>.
|
|
|
|
|
This will load the file at the specified URL during startup when Smack initializes.
|
|
|
|
|
This also assumes the default configuration, since it requires that the <b>VmArgInitializer</b> was
|
|
|
|
|
part of the startup configuration.
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
-Dsmack.provider.file=classpath:com/myco/provider/myco_custom.providers
|
|
|
|
|
or
|
|
|
|
|
-Dsmack.provider.file=file:///c:/myco/provider/myco_custom.providers
|
|
|
|
|
</pre>
|
|
|
|
|
</ul>
|
2003-10-13 19:34:45 +02:00
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
<p class="subheader">IQ Providers</p>
|
2003-10-13 19:34:45 +02:00
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
<p>
|
|
|
|
|
<i>Introspection</i>
|
|
|
|
|
<p>
|
|
|
|
|
<u>Time Packet</u>
|
2003-10-13 19:34:45 +02:00
|
|
|
<pre>
|
2014-01-16 06:14:39 +01:00
|
|
|
<iq type='result' 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>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<u>Time IQ Class</u>
|
|
|
|
|
<pre>
|
|
|
|
|
class Time extends IQ {
|
|
|
|
|
private Date utc;
|
|
|
|
|
private TimeZone timeZone;
|
|
|
|
|
private String display;
|
|
|
|
|
|
|
|
|
|
@Override
|
|
|
|
|
public String getChildElementXML() {
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setUtc(String utcString) {
|
|
|
|
|
try {
|
|
|
|
|
utc = StringUtils.parseDate(utcString);
|
|
|
|
|
} catch (ParseException e) {
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setTimeZone(String zone) {
|
|
|
|
|
timeZone = TimeZone.getTimeZone(zone);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void setDisplay(String timeDisplay) {
|
|
|
|
|
display = timeDisplay;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
The introspection service will automatically try to convert the String
|
2003-10-13 19:34:45 +02:00
|
|
|
value from the XML into a boolean, int, long, float, double, or Class depending on the
|
2014-01-16 06:14:39 +01:00
|
|
|
type the IQ instance expects.
|
2003-10-13 19:34:45 +02:00
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
<p>
|
|
|
|
|
<i>IQProvider Implementation</i>
|
|
|
|
|
<p>
|
|
|
|
|
<u>Disco Items Packet</u>
|
|
|
|
|
<pre>
|
|
|
|
|
<iq type='result' from='shakespeare.lit' to='romeo@montague.net/orchard' id='items1'>
|
|
|
|
|
<query xmlns='http://jabber.org/protocol/disco#items'>
|
|
|
|
|
<item jid='people.shakespeare.lit' name='Directory of Characters'/>
|
|
|
|
|
<item jid='plays.shakespeare.lit' name='Play-Specific Chatrooms'/>
|
|
|
|
|
<item jid='mim.shakespeare.lit' name='Gateway to Marlowe IM'/>
|
|
|
|
|
<item jid='words.shakespeare.lit' name='Shakespearean Lexicon'/>
|
|
|
|
|
<item jid='globe.shakespeare.lit' name='Calendar of Performances'/>
|
|
|
|
|
<item jid='headlines.shakespeare.lit' name='Latest Shakespearean News'/>
|
|
|
|
|
<item jid='catalog.shakespeare.lit' name='Buy Shakespeare Stuff!'/>
|
|
|
|
|
<item jid='en2fr.shakespeare.lit' name='French Translation Service'/>
|
|
|
|
|
</query>
|
|
|
|
|
</iq>
|
|
|
|
|
</pre>
|
2003-10-13 19:34:45 +02:00
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
<p>
|
|
|
|
|
<u>Disco Items IQProvider</u>
|
|
|
|
|
<pre>
|
|
|
|
|
public class DiscoverItemsProvider implements IQProvider {
|
|
|
|
|
|
|
|
|
|
public IQ parseIQ(XmlPullParser parser) throws Exception {
|
|
|
|
|
DiscoverItems discoverItems = new DiscoverItems();
|
|
|
|
|
boolean done = false;
|
|
|
|
|
DiscoverItems.Item item;
|
|
|
|
|
String jid = "";
|
|
|
|
|
String name = "";
|
|
|
|
|
String action = "";
|
|
|
|
|
String node = "";
|
|
|
|
|
discoverItems.setNode(parser.getAttributeValue("", "node"));
|
|
|
|
|
while (!done) {
|
|
|
|
|
int eventType = parser.next();
|
|
|
|
|
|
|
|
|
|
if (eventType == XmlPullParser.START_TAG && "item".equals(parser.getName())) {
|
|
|
|
|
// Initialize the variables from the parsed XML
|
|
|
|
|
jid = parser.getAttributeValue("", "jid");
|
|
|
|
|
name = parser.getAttributeValue("", "name");
|
|
|
|
|
node = parser.getAttributeValue("", "node");
|
|
|
|
|
action = parser.getAttributeValue("", "action");
|
|
|
|
|
}
|
|
|
|
|
else if (eventType == XmlPullParser.END_TAG && "item".equals(parser.getName())) {
|
|
|
|
|
// Create a new Item and add it to DiscoverItems.
|
|
|
|
|
item = new DiscoverItems.Item(jid);
|
|
|
|
|
item.setName(name);
|
|
|
|
|
item.setNode(node);
|
|
|
|
|
item.setAction(action);
|
|
|
|
|
discoverItems.addItem(item);
|
|
|
|
|
}
|
|
|
|
|
else if (eventType == XmlPullParser.END_TAG && "query".equals(parser.getName())) {
|
|
|
|
|
done = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return discoverItems;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p class="subheader">Extension Providers</p>
|
|
|
|
|
|
|
|
|
|
Packet extension providers are responsible for parsing packet extensions, which are
|
|
|
|
|
child elements in a custom namespace of IQ, message and presence packets.
|
|
|
|
|
<p>
|
|
|
|
|
<u>Pubsub Subscription Packet</u>
|
|
|
|
|
|
|
|
|
|
<pre>
|
|
|
|
|
<iq type='result' from='pubsub.shakespeare.lit' to='francisco@denmark.lit/barracks' id='sub1'>
|
|
|
|
|
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
|
|
|
|
|
<subscription node='princely_musings' jid='francisco@denmark.lit' subscription='unconfigured'>
|
|
|
|
|
<subscribe-options>
|
|
|
|
|
<required/>
|
|
|
|
|
</subscribe-options>
|
|
|
|
|
</subscription>
|
|
|
|
|
</pubsub>
|
|
|
|
|
</iq>
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<u>Subscription PacketExtensionProvider Implementation</u>
|
2003-10-13 19:34:45 +02:00
|
|
|
|
|
|
|
|
<pre>
|
2014-01-16 06:14:39 +01:00
|
|
|
public class SubscriptionProvider implements PacketExtensionProvider {
|
|
|
|
|
public PacketExtension parseExtension(XmlPullParser parser) throws Exception {
|
|
|
|
|
String jid = parser.getAttributeValue(null, "jid");
|
|
|
|
|
String nodeId = parser.getAttributeValue(null, "node");
|
|
|
|
|
String subId = parser.getAttributeValue(null, "subid");
|
|
|
|
|
String state = parser.getAttributeValue(null, "subscription");
|
|
|
|
|
boolean isRequired = false;
|
|
|
|
|
|
|
|
|
|
int tag = parser.next();
|
|
|
|
|
|
|
|
|
|
if ((tag == XmlPullParser.START_TAG) && parser.getName().equals("subscribe-options")) {
|
|
|
|
|
tag = parser.next();
|
|
|
|
|
|
|
|
|
|
if ((tag == XmlPullParser.START_TAG) && parser.getName().equals("required"))
|
|
|
|
|
isRequired = true;
|
|
|
|
|
|
|
|
|
|
while (parser.next() != XmlPullParser.END_TAG && parser.getName() != "subscribe-options");
|
|
|
|
|
}
|
|
|
|
|
while (parser.getEventType() != XmlPullParser.END_TAG) parser.next();
|
|
|
|
|
return new Subscription(jid, nodeId, subId, (state == null ? null : Subscription.State.valueOf(state)), isRequired);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
</pre>
|
|
|
|
|
|
|
|
|
|
<p class="subheader">Provider file format</p>
|
|
|
|
|
|
|
|
|
|
This is the format for a provider file which can be parsed by the <b>ProviderFileLoader</b>.
|
|
|
|
|
<pre>
|
|
|
|
|
<?xml version="1.0"?>
|
|
|
|
|
<smackProviders>
|
|
|
|
|
<iqProvider>
|
|
|
|
|
<elementName>query</elementName>
|
|
|
|
|
<namespace>jabber:iq:time</namespace>
|
|
|
|
|
<className>org.jivesoftware.smack.packet.Time</className>
|
|
|
|
|
</iqProvider>
|
|
|
|
|
|
|
|
|
|
<iqProvider>
|
|
|
|
|
<elementName>query</elementName>
|
|
|
|
|
<namespace>http://jabber.org/protocol/disco#items</namespace>
|
|
|
|
|
<className>org.jivesoftware.smackx.provider.DiscoverItemsProvider</className>
|
|
|
|
|
</iqProvider>
|
|
|
|
|
|
2003-10-13 19:34:45 +02:00
|
|
|
<extensionProvider>
|
2014-01-16 06:14:39 +01:00
|
|
|
<elementName>subscription</elementName>
|
|
|
|
|
<namespace>http://jabber.org/protocol/pubsub</namespace>
|
|
|
|
|
<className>org.jivesoftware.smackx.pubsub.provider.SubscriptionProvider</className>
|
2003-10-13 19:34:45 +02:00
|
|
|
</extensionProvider>
|
2014-01-16 06:14:39 +01:00
|
|
|
</smackProviders></pre>
|
2003-10-13 19:34:45 +02:00
|
|
|
|
2014-01-16 06:14:39 +01:00
|
|
|
Each provider is associated with an element name and a namespace. If multiple provider entries attempt to register to
|
|
|
|
|
handle the same namespace, the last entry added to the <b>ProviderManager</b> will overwrite any other that was loaded
|
|
|
|
|
before it.
|
|
|
|
|
<p>
|
2003-10-13 19:34:45 +02:00
|
|
|
|
|
|
|
|
|
2003-06-19 20:15:28 +02:00
|
|
|
|
|
|
|
|
<br clear="all" /><br><br>
|
|
|
|
|
|
|
|
|
|
<div class="footer">
|
2008-11-03 17:28:57 +01:00
|
|
|
Copyright © Jive Software 2002-2008
|
2003-06-19 20:15:28 +02:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
