2003-01-15 16:03:36 +01:00
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<title>Smack: Packet Properties - Jive Software</title>
|
2008-11-03 17:28:57 +01:00
|
|
|
<link rel="stylesheet" type="text/css" href="style.css" />
|
2003-01-15 16:03:36 +01:00
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
|
|
|
|
|
|
<div class="header">
|
|
|
|
|
Packet Properties
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Smack provides an easy mechanism for attaching arbitrary properties to packets. Each property
|
|
|
|
|
has a String name, and a value that is a Java primitive (int, long, float, double, boolean) or
|
|
|
|
|
any Serializable object (a Java object is Serializable when it implements the Serializable
|
|
|
|
|
interface).
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p class="subheader">
|
|
|
|
|
Using the API
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
All major objects have property support, such as Message objects. The following code
|
|
|
|
|
demonstrates how to set properties:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<div class="code"><pre>
|
|
|
|
|
Message message = chat.createMessage();
|
2014-04-26 15:43:58 +02:00
|
|
|
JivePropertiesExtension jpe = new JivePropertiesExtension();
|
2008-11-03 17:28:57 +01:00
|
|
|
<font color="gray"><i>// Add a Color object as a property.</i></font>
|
2014-04-26 15:43:58 +02:00
|
|
|
jpe.setProperty(<font color="blue">"favoriteColor"</font>, new Color(0, 0, 255));
|
2008-11-03 17:28:57 +01:00
|
|
|
<font color="gray"><i>// Add an int as a property.</i></font>
|
2014-04-26 15:43:58 +02:00
|
|
|
jpe.setProperty(<font color="blue">"favoriteNumber"</font>, 4);
|
|
|
|
|
<font color="gray"><i>// Add the JivePropertiesExtension to the message packet</i></font>
|
|
|
|
|
message.addPacketExtension(jpe);
|
2003-01-15 16:03:36 +01:00
|
|
|
chat.sendMessage(message);
|
|
|
|
|
</pre></div>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Getting those same properties would use the following code:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<div class="code"><pre>
|
|
|
|
|
Message message = chat.nextMessage();
|
2014-04-26 15:43:58 +02:00
|
|
|
<font color="gray"><i>// Get the JivePropertiesExtension</i></font>
|
|
|
|
|
JivePropertiesExtension jpe = message.getExtension(JivePropertiesExtension.NAMESPACE);
|
2008-11-03 17:28:57 +01:00
|
|
|
<font color="gray"><i>// Get a Color object property.</i></font>
|
2014-04-26 15:43:58 +02:00
|
|
|
Color favoriteColor = (Color)jpe.getProperty(<font color="blue">"favoriteColor"</font>);
|
2008-11-03 17:28:57 +01:00
|
|
|
<font color="gray"><i>// Get an int property. Note that properties are always returned as
|
2003-01-15 16:03:36 +01:00
|
|
|
// Objects, so we must cast the value to an Integer, then convert
|
|
|
|
|
// it to an int.</i></font>
|
2014-04-26 15:43:58 +02:00
|
|
|
int favoriteNumber = ((Integer)jpe.getProperty(<font color="blue">"favoriteNumber"</font>)).intValue();
|
2003-01-15 16:03:36 +01:00
|
|
|
</pre></div>
|
|
|
|
|
|
2014-04-26 15:43:58 +02:00
|
|
|
<p>
|
|
|
|
|
For convenience <code>JivePropertiesManager</code> contains two helper
|
|
|
|
|
methods namely <code>addProperty(Packet packet, String name, Object
|
|
|
|
|
value)</code> and
|
|
|
|
|
<code>getProperty(Packet packet, String name)</code>.
|
|
|
|
|
</p>
|
|
|
|
|
|
2003-01-15 16:03:36 +01:00
|
|
|
<p class="subheader">
|
|
|
|
|
Objects as Properties
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
Using objects as property values is a very powerful and easy way to exchange data. However,
|
|
|
|
|
you should keep the following in mind:
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<ul>
|
2003-06-19 20:11:37 +02:00
|
|
|
<li>When you send a Java object as a property, only clients running Java will be able to
|
|
|
|
|
interpret the data. So, consider using a series of primitive values to transfer data
|
|
|
|
|
instead.
|
2003-01-15 16:03:36 +01:00
|
|
|
|
|
|
|
|
<li>Objects sent as property values must implement Serialiable. Additionally, both the sender
|
|
|
|
|
and receiver must have identical versions of the class, or a serialization exception
|
2003-08-30 16:11:52 +02:00
|
|
|
will occur when de-serializing the object.
|
2003-01-15 16:03:36 +01:00
|
|
|
|
|
|
|
|
<li>Serialized objects can potentially be quite large, which will use more bandwidth and
|
|
|
|
|
server resources.
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
<p class="subheader">
|
|
|
|
|
XML Format
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The current XML format used to send property data is not a standard, so will likely not be
|
|
|
|
|
recognized by clients not using Smack. The XML looks like the following (comments added for
|
|
|
|
|
clarity):
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<div class="code"><pre>
|
|
|
|
|
<font color="gray"><i><!-- All properties are in a x block. --></i></font>
|
2003-05-08 17:52:43 +02:00
|
|
|
<properties xmlns="http://www.jivesoftware.com/xmlns/xmpp/properties">
|
|
|
|
|
<font color="gray"><i><!-- First, a property named "prop1" that's an integer. --></i></font>
|
|
|
|
|
<property>
|
|
|
|
|
<name>prop1</name>
|
|
|
|
|
<value type="integer">123</value>
|
|
|
|
|
<property>
|
|
|
|
|
<font color="gray"><i><!-- Next, a Java object that's been serialized and then converted
|
|
|
|
|
from binary data to base-64 encoded text. --></i></font>
|
|
|
|
|
<property>
|
|
|
|
|
<name>blah2</name>
|
|
|
|
|
<value type="java-object">adf612fna9nab</value>
|
|
|
|
|
<property>
|
|
|
|
|
</properties>
|
2003-01-15 16:03:36 +01:00
|
|
|
</pre></div>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
The currently supported types are: <tt>integer</tt>, <tt>long</tt>, <tt>float</tt>,
|
|
|
|
|
<tt>double</tt>, <tt>boolean</tt>, <tt>string</tt>, and <tt>java-object</tt>.
|
|
|
|
|
</p>
|
|
|
|
|
|
|
|
|
|
<div class="footer">
|
2008-11-03 17:28:57 +01:00
|
|
|
Copyright © Jive Software 2002-2008
|
2003-01-15 16:03:36 +01:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
