1d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 2d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $RCSfile$ 3d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Revision$ 4d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * $Date$ 5d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 6d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Copyright 2003-2007 Jive Software. 7d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 8d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); 9d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * you may not use this file except in compliance with the License. 10d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * You may obtain a copy of the License at 11d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 12d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * http://www.apache.org/licenses/LICENSE-2.0 13d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 14d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Unless required by applicable law or agreed to in writing, software 15d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * distributed under the License is distributed on an "AS IS" BASIS, 16d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 17d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * See the License for the specific language governing permissions and 18d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * limitations under the License. 19d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 20d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 21d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpackage org.jivesoftware.smackx.packet; 22d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 23d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.jivesoftware.smack.packet.PacketExtension; 24d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.ArrayList; 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Collections; 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.Iterator; 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport java.util.List; 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * An XHTML sub-packet, which is used by XMPP clients to exchange formatted text. The XHTML 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * extension is only a subset of XHTML 1.0.<p> 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * The following link summarizes the requirements of XHTML IM: 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <a href="http://www.jabber.org/jeps/jep-0071.html#sect-id2598018">Valid tags</a>.<p> 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Warning: this is an non-standard protocol documented by 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <a href="http://www.jabber.org/jeps/jep-0071.html">JEP-71</a>. Because this is a 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * non-standard protocol, it is subject to change. 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Gaston Dombiak 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class XHTMLExtension implements PacketExtension { 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private List<String> bodies = new ArrayList<String>(); 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the XML element name of the extension sub-packet root element. 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Always returns "html" 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the XML element name of the packet extension. 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getElementName() { 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return "html"; 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the XML namespace of the extension sub-packet root element. 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * According the specification the namespace is always "http://jabber.org/protocol/xhtml-im" 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the XML namespace of the packet extension. 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getNamespace() { 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return "http://jabber.org/protocol/xhtml-im"; 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the XML representation of a XHTML extension according the specification. 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Usually the XML representation will be inside of a Message XML representation like 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * in the following example: 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <pre> 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <message id="MlIpV-4" to="gato1@gato.home" from="gato3@gato.home/Smack"> 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <subject>Any subject you want</subject> 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <body>This message contains something interesting.</body> 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <html xmlns="http://jabber.org/protocol/xhtml-im"> 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * <body><p style='font-size:large'>This message contains something <em>interesting</em>.</p></body> 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * </html> 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * </message> 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * </pre> 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String toXML() { 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen StringBuilder buf = new StringBuilder(); 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<").append(getElementName()).append(" xmlns=\"").append(getNamespace()).append( 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen "\">"); 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen // Loop through all the bodies and append them to the string buffer 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen for (Iterator<String> i = getBodies(); i.hasNext();) { 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append(i.next()); 90d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 91d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("</").append(getElementName()).append(">"); 92d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return buf.toString(); 93d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 94d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 95d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 96d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns an Iterator for the bodies in the packet. 97d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 98d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return an Iterator for the bodies in the packet. 99d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 100d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Iterator<String> getBodies() { 101d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen synchronized (bodies) { 102d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return Collections.unmodifiableList(new ArrayList<String>(bodies)).iterator(); 103d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 104d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 105d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 106d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 107d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Adds a body to the packet. 108d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 109d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param body the body to add. 110d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 111d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void addBody(String body) { 112d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen synchronized (bodies) { 113d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen bodies.add(body); 114d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 115d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 116d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 117d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 118d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns a count of the bodies in the XHTML packet. 119d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 120d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the number of bodies in the XHTML packet. 121d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 122d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public int getBodiesCount() { 123d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return bodies.size(); 124d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 125d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 126d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen} 127