Smack/documentation/extensions/caps.html

<html>
<head>
<title>Entity Capabilities</title>
<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>

<div class="header">Entity Capabilities</div><p>
This section details the usage of Smacks implementation of Entity Capabilities.
</p>
<b>XEP related:</b> <a href="http://xmpp.org/extensions/xep-0115.html">XEP-0115: Entity Capabilities</a>

<hr>

<b>Description</b><p>

Entity Capabilities is a XMPP Protocol extension, which, in order to minimize network impact, caches the capabilities of XMPP entities. Those capabilities are determined with the help of the Service Discovery Protocol (<a href="http://xmpp.org/extensions/xep-0030.html">XEP-0030</a>).

</p>

<b>Usage</b><p>

Entity Capabilities work silenty in background when enabled. If the remote XMPP entity does not support XEP-0115 but XEP-0030 then XEP-0030 mechanisms are transparently used. You can enable or disable Entity Capabilities by using <i><b>EntityCapsManager</b></i>.<br>

The cache used by Smack for Entity Capabilities is non-persistent as default. That is, the cache only uses memory. But it is also possible to set a persistent Entity Capabilities cache, which is recommended.
</p>

<b>Examples</b><p>

Enable Entity Capabilities
<br>
<blockquote>
<pre>
      <font color="#3f7f5f">// Get an instance of entity caps manager for the specified connection</font>
      EntityCapsManager mgr = EntityCapsManager.getInstanceFor(connection);

      <font color="#3f7f5f">// Enable entity capabilities</font>
      mgr.enableEntityCaps();
</pre>
</blockquote>

Configure a persistent cache for Entity Capabilities
<br>
<blockquote>
<pre>
      <font color="#3f7f5f">// Get an instance of entity caps manager for the specified connection</font>
      EntityCapsManager mgr = EntityCapsManager.getInstanceFor(connection);

      <font color="#3f7f5f">// Create an cache, see smackx.entitycaps.cache for pre-defined cache implementations</font>
      EntityCapsPersistentCache cache = new SimpleDirectoryPersistentCache(new File("/foo/cachedir"));

      <font color="#3f7f5f">// Set the cache</font>
      mgr.setPersistentCache(cache);
</pre>
</blockquote>
</p>

<hr>

</body>

</html>
SMACK-431 Entity Capabilities are now enabled as default for new connections. Added an extensions documentation html page. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_1@13689 b35dd754-fafc-0310-a699-88a17e54d16e 2013-06-22 19:01:58 +02:00			`<html>`
			`<head>`
			`<title>Entity Capabilities</title>`
			`<link rel="stylesheet" type="text/css" href="style.css" />`
			`</head>`

			`<body>`

			`<div class="header">Entity Capabilities</div><p>`
			`This section details the usage of Smacks implementation of Entity Capabilities.`
			`</p>`
			`<b>XEP related:</b> <a href="http://xmpp.org/extensions/xep-0115.html">XEP-0115: Entity Capabilities</a>`

			`<hr>`

			`<b>Description</b><p>`

SMACK-431 Reworded Entity Caps documentation, added missing frame link git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_1@13692 b35dd754-fafc-0310-a699-88a17e54d16e 2013-06-24 23:27:43 +02:00			`Entity Capabilities is a XMPP Protocol extension, which, in order to minimize network impact, caches the capabilities of XMPP entities. Those capabilities are determined with the help of the Service Discovery Protocol (<a href="http://xmpp.org/extensions/xep-0030.html">XEP-0030</a>).`
SMACK-431 Entity Capabilities are now enabled as default for new connections. Added an extensions documentation html page. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_1@13689 b35dd754-fafc-0310-a699-88a17e54d16e 2013-06-22 19:01:58 +02:00
			`</p>`

			`<b>Usage</b><p>`

			`Entity Capabilities work silenty in background when enabled. If the remote XMPP entity does not support XEP-0115 but XEP-0030 then XEP-0030 mechanisms are transparently used. You can enable or disable Entity Capabilities by using <i><b>EntityCapsManager</b></i>.<br>`

			`The cache used by Smack for Entity Capabilities is non-persistent as default. That is, the cache only uses memory. But it is also possible to set a persistent Entity Capabilities cache, which is recommended.`
			`</p>`

			`<b>Examples</b><p>`

			`Enable Entity Capabilities`
			`<br>`
			`<blockquote>`
			`<pre>`
			`<font color="#3f7f5f">// Get an instance of entity caps manager for the specified connection</font>`
SMACK-361 Minor EntityCapsManager fixes Don't use the constructor in ConnectionCreationListener to prevent duplicate instances for the same connection. Fixed EntityCaps documentation. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_2@13799 b35dd754-fafc-0310-a699-88a17e54d16e 2013-11-03 22:49:39 +01:00			`EntityCapsManager mgr = EntityCapsManager.getInstanceFor(connection);`
SMACK-431 Entity Capabilities are now enabled as default for new connections. Added an extensions documentation html page. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_1@13689 b35dd754-fafc-0310-a699-88a17e54d16e 2013-06-22 19:01:58 +02:00
			`<font color="#3f7f5f">// Enable entity capabilities</font>`
			`mgr.enableEntityCaps();`
			`</pre>`
			`</blockquote>`

			`Configure a persistent cache for Entity Capabilities`
			`<br>`
			`<blockquote>`
			`<pre>`
			`<font color="#3f7f5f">// Get an instance of entity caps manager for the specified connection</font>`
SMACK-361 Minor EntityCapsManager fixes Don't use the constructor in ConnectionCreationListener to prevent duplicate instances for the same connection. Fixed EntityCaps documentation. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_2@13799 b35dd754-fafc-0310-a699-88a17e54d16e 2013-11-03 22:49:39 +01:00			`EntityCapsManager mgr = EntityCapsManager.getInstanceFor(connection);`
SMACK-431 Entity Capabilities are now enabled as default for new connections. Added an extensions documentation html page. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/branches/smack_3_3_1@13689 b35dd754-fafc-0310-a699-88a17e54d16e 2013-06-22 19:01:58 +02:00
			`<font color="#3f7f5f">// Create an cache, see smackx.entitycaps.cache for pre-defined cache implementations</font>`
			`EntityCapsPersistentCache cache = new SimpleDirectoryPersistentCache(new File("/foo/cachedir"));`

			`<font color="#3f7f5f">// Set the cache</font>`
			`mgr.setPersistentCache(cache);`
			`</pre>`
			`</blockquote>`
			`</p>`

			`<hr>`

			`</body>`

			`</html>`