vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-12-18 16:47:58 +01:00
Code Issues Releases Wiki Activity

Merge pull request #228 from fuentesj11/update-providers-doc

Browse source 
Update providers.md
This commit is contained in:
Florian Schmaus 2018-04-04 14:49:49 +02:00 committed by GitHub
commit a0d769225c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
documentation/providers.md
View file

@ -12,7 +12,7 @@ Extensions](extensions/index.md) are built using the provider architecture.
There are two types of providers: There are two types of providers:
* `IQProvider` -- parses IQ requests into Java objects. * `IQProvider` -- parses IQ requests into Java objects.
* `Extension Provider` -- parses XML sub-documents attached to packets into PacketExtension instances. By default, Smack only knows how to process a few standard packets and sub-packets that are in a few namespaces such as: * `Extension Provider` -- parses XML sub-documents attached to packets into ExtensionElement instances. By default, Smack only knows how to process a few standard packets and sub-packets that are in a few namespaces such as:
* jabber:iq:auth * jabber:iq:auth
* jabber:iq:roster * jabber:iq:roster
* jabber:iq:register * jabber:iq:register
@ -20,8 +20,8 @@ There are two types of providers:
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. 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.
Whenever a packet extension is found in a packet, parsing will be Whenever a packet extension is found in a packet, parsing will be
passed to the correct provider. Each provider must implement the passed to the correct provider. Each provider must extend the
PacketExtensionProvider interface. Each extension provider is ExtensionElementProvider abstract class. Each extension provider is
responsible for parsing the raw XML stream, via the responsible for parsing the raw XML stream, via the
[XML Pull Parser](http://www.xmlpull.org/), to contruct an object. [XML Pull Parser](http://www.xmlpull.org/), to contruct an object.
@ -32,7 +32,7 @@ of the class using the values in the packet extension sub-element.
When no extension provider is registered for an element name and namespace 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 combination, Smack will store all top-level elements of the sub-packet in the
DefaultPacketExtension object and then attach it to the packet. StandardExtensionElement object and then attach it to the packet.
Management of these providers is accomplished via the [ProviderManager]() Management of these providers is accomplished via the [ProviderManager]()
class. There are multiple ways to add providers to the manager. class. There are multiple ways to add providers to the manager.
@ -53,7 +53,7 @@ ProviderManager.addExtensionProvider("element", "namespace", new MyExtProvider()
* VM Argument - You can add a provider file via the VM argument _smack.provider.file_. 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 **VmArgInitializer** was part of the startup configuration. * VM Argument - You can add a provider file via the VM argument _smack.provider.file_. 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 **VmArgInitializer** was part of the startup configuration.
`-Dsmack.provider.file=classpath:com/myco/provider/myco_custom.provider`s `-Dsmack.provider.file=classpath:com/myco/provider/myco_custom.providers`
or or
@ -63,13 +63,13 @@ or
IQ Providers IQ Providers
------------ ------------
The IQ provider class must implement the IQProvider interface. Each The IQ provider class must extend the IQProvider abstract class. Each
IQProvider is responsible for parsing the raw XML stream to create an IQProvider is responsible for parsing the raw XML stream to create an
IQ instance. IQ instance.
You can also create an introspection provider You can also create an introspection provider
(`provider.IntrospectionProvider.IQIntrospectionProvider`). Which (`provider.IntrospectionProvider.IQIntrospectionProvider`). Which
uses, bean introspection to try to automatically set properties of the uses bean introspection to try to automatically set properties of the
IQ instance using the values found in the IQ packet XML. For example, IQ instance using the values found in the IQ packet XML. For example,
an XMPP time packet resembles the following: an XMPP time packet resembles the following:
@ -287,8 +287,8 @@ _Pubsub Subscription Stanza_
_Subscription PacketExtensionProvider Implementation_ _Subscription PacketExtensionProvider Implementation_
public class SubscriptionProvider implements PacketExtensionProvider { public class SubscriptionProvider extends ExtensionElementProvider<ExtensionElement> {
public PacketExtension parseExtension(XmlPullParser parser) throws Exception { public ExtensionElement parse(XmlPullParser parser) throws Exception {
String jid = parser.getAttributeValue(null, "jid"); String jid = parser.getAttributeValue(null, "jid");
String nodeId = parser.getAttributeValue(null, "node"); String nodeId = parser.getAttributeValue(null, "node");
String subId = parser.getAttributeValue(null, "subid"); String subId = parser.getAttributeValue(null, "subid");
@ -306,7 +306,7 @@ _Subscription PacketExtensionProvider Implementation_
while (parser.next() != XmlPullParser.END_TAG && parser.getName() != "subscribe-options"); while (parser.next() != XmlPullParser.END_TAG && parser.getName() != "subscribe-options");
} }
while (parser.getEventType() != XmlPullParser.END_TAG) parser.next(); while (parser.getEventType() != XmlPullParser.END_TAG) parser.next();
return new Subscription(jid, nodeId, subId, (state == null ? null : Subscription.State.valueOf(state), isRequired); return new Subscription(jid, nodeId, subId, state == null ? null : Subscription.State.valueOf(state), isRequired);
} }
} }