* <iq type='result' to='joe@example.com' from='mary@example.com' id='time_1'>
* <query xmlns='jabber:iq:private'>
* <prefs xmlns='http://www.xmppclient.com/prefs'>
* <value1>ABC</value1>
* <value2>XYZ</value2>
* </prefs>
* </query>
* </iq>
*
* Note: this method is generally only called by the internal Smack classes. * * @param elementName the XML element name. * @param namespace the XML namespace. * @return the IQ provider. */ public static Object getPrivateDataProvider(String elementName, String namespace) { String key = getProviderKey(elementName, namespace); return privateDataProviders.get(key); } /** * Adds a private data 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 static void addIQProvider(String elementName, String namespace, IQProvider provider) { String key = getProviderKey(elementName, namespace); privateDataProviders.put(key, provider); } /** * Creates a new private data manager. * * @param con an XMPPConnection. */ public PrivateDataManager(XMPPConnection con) { this.con = con; this.userID = con.getUsername() + "@" + con.getHost(); } /** * Returns the private data specified by the given element name and namespace. * * @param elementName the element name. * @param namespace the namespace. * @return the private data. * @throws XMPPException */ public PrivateData getPrivateData(final String elementName, final String namespace) throws XMPPException { // Create an IQ packet to get the private data. IQ privateDataGet = new IQ() { public String getChildElementXML() { StringBuffer buf = new StringBuffer(); buf.append("<").append(elementName).append(" xmlns=\"").append(namespace).append("\"/>"); return buf.toString(); } }; privateDataGet.setType(IQ.Type.GET); // Setup a listener for the reply to the set operation. String packetID = privateDataGet.getPacketID(); PacketCollector collector = con.createPacketCollector(new PacketIDFilter(packetID)); // Send the private data. con.sendPacket(privateDataGet); // Wait up to five seconds for a response from the server. IQ response = (IQ)collector.nextResult(5000); if (response == null) { throw new XMPPException("No response from the server."); } // If the server replied with an error, throw an exception. else if (response.getType() == IQ.Type.ERROR) { throw new XMPPException(response.getError()); } return ((PrivateDataResult)response).getPrivateData(); } public void setPrivateData(final PrivateData privateData) throws XMPPException { // Create an IQ packet to set the private data. IQ privateDataSet = new IQ() { public String getChildElementXML() { return privateData.toXML(); } }; privateDataSet.setType(IQ.Type.SET); // Setup a listener for the reply to the set operation. String packetID = privateDataSet.getPacketID(); PacketCollector collector = con.createPacketCollector(new PacketIDFilter(packetID)); // Send the private data. con.sendPacket(privateDataSet); // Wait up to five seconds for a response from the server. IQ response = (IQ)collector.nextResult(5000); if (response == null) { throw new XMPPException("No response from the server."); } // If the server replied with an error, throw an exception. else if (response.getType() == IQ.Type.ERROR) { throw new XMPPException(response.getError()); } } /** * Returns a String key for a given element name and namespace. * * @param elementName the element name. * @param namespace the namespace. * @return a unique key for the element name and namespace pair. */ private static String getProviderKey(String elementName, String namespace) { StringBuffer buf = new StringBuffer(); buf.append("<").append(elementName).append("/><").append(namespace).append("/>"); return buf.toString(); } /** * An IQ provider to parse IQ results containing private data. */ public static class PrivateDataIQProvider implements IQProvider { public IQ parseIQ(XmlPullParser parser) throws Exception { PrivateData privateData = null;; boolean done = false; while (!done) { int eventType = parser.next(); if (eventType == XmlPullParser.START_TAG) { String elementName = parser.getName(); String namespace = parser.getNamespace(); // See if any objects are registered to handle this private data type. Object provider = getPrivateDataProvider(elementName, namespace); // If there is a registered provider, use it. if (provider != null) { if (provider instanceof PrivateDataProvider) { privateData = ((PrivateDataProvider)provider).parsePrivateData(parser); } // Otherwise it's a JavaBean, so use introspection. else { privateData = parseWithIntrospection(elementName, (Class)provider, parser); } } // Otherwise, use a DefaultPrivateData instance to store the private data. else { DefaultPrivateData data = new DefaultPrivateData(elementName, namespace); boolean finished = false; while (!finished) { int event = parser.next(); if (event == XmlPullParser.START_TAG) { String name = parser.getName(); // If an empty element, set the value with the empty string. if (parser.isEmptyElementTag()) { data.setValue(name,""); } // Otherwise, get the the element text. else { event = parser.next(); if (event == XmlPullParser.TEXT) { String value = parser.getText(); data.setValue(name, value); } } } else if (event == XmlPullParser.END_TAG) { if (parser.getName().equals(elementName)) { finished = true; } } } privateData = data; } } else if (eventType == XmlPullParser.END_TAG) { if (parser.getName().equals("")) { done = true; } } } return new PrivateDataResult(privateData); } } private static PrivateData parseWithIntrospection(String elementName, Class objectClass, XmlPullParser parser) throws Exception { boolean done = false; PrivateData object = (PrivateData)objectClass.newInstance(); while (!done) { int eventType = parser.next(); if (eventType == XmlPullParser.START_TAG) { String name = parser.getName(); String stringValue = parser.nextText(); PropertyDescriptor descriptor = new PropertyDescriptor(name, objectClass); // Load the class type of the property. Class propertyType = descriptor.getPropertyType(); // Get the value of the property by converting it from a // String to the correct object type. Object value = decode(propertyType, stringValue); // Set the value of the bean. descriptor.getWriteMethod().invoke(object, new Object[] { value }); } else if (eventType == XmlPullParser.END_TAG) { if (parser.getName().equals(elementName)) { done = true; } } } return object; } /** * Decodes a String into an object of the specified type. If the object * type is not supported, null will be returned. * * @param type the type of the property. * @param value the encode String value to decode. * @return the String value decoded into the specified type. */ private static Object decode(Class type, String value) throws Exception { if (type.getName().equals("java.lang.String")) { return value; } if (type.getName().equals("boolean")) { return Boolean.valueOf(value); } if (type.getName().equals("int")) { return Integer.valueOf(value); } if (type.getName().equals("long")) { return Long.valueOf(value); } if (type.getName().equals("float")) { return Float.valueOf(value); } if (type.getName().equals("double")) { return Double.valueOf(value); } if (type.getName().equals("java.lang.Class")) { return Class.forName(value); } return null; } /** * An IQ packet to hold PrivateData GET results. */ private static class PrivateDataResult extends IQ { private PrivateData privateData; PrivateDataResult(PrivateData privateData) { this.privateData = privateData; } public PrivateData getPrivateData() { return privateData; } public String getChildElementXML() { return privateData.toXML(); } } }