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 Chenimport org.jivesoftware.smack.provider.PacketExtensionProvider; 25d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenimport org.xmlpull.v1.XmlPullParser; 26d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 27d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen/** 28d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * OfflineMessageInfo is an extension included in the retrieved offline messages requested by 29d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * the {@link org.jivesoftware.smackx.OfflineMessageManager}. This extension includes a stamp 30d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * that uniquely identifies the offline message. This stamp may be used for deleting the offline 31d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * message. The stamp may be of the form UTC timestamps but it is not required to have that format. 32d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 33d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @author Gaston Dombiak 34d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 35d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chenpublic class OfflineMessageInfo implements PacketExtension { 36d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 37d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen private String node = null; 38d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 39d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 40d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the XML element name of the extension sub-packet root element. 41d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Always returns "offline" 42d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 43d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the XML element name of the packet extension. 44d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 45d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getElementName() { 46d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return "offline"; 47d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 48d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 49d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 50d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the XML namespace of the extension sub-packet root element. 51d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * According the specification the namespace is always "http://jabber.org/protocol/offline" 52d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 53d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the XML namespace of the packet extension. 54d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 55d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getNamespace() { 56d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return "http://jabber.org/protocol/offline"; 57d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 58d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 59d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 60d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Returns the stamp that uniquely identifies the offline message. This stamp may 61d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * be used for deleting the offline message. The stamp may be of the form UTC timestamps 62d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * but it is not required to have that format. 63d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 64d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return the stamp that uniquely identifies the offline message. 65d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 66d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String getNode() { 67d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return node; 68d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 69d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 70d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 71d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Sets the stamp that uniquely identifies the offline message. This stamp may 72d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * be used for deleting the offline message. The stamp may be of the form UTC timestamps 73d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * but it is not required to have that format. 74d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 75d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param node the stamp that uniquely identifies the offline message. 76d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 77d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public void setNode(String node) { 78d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen this.node = node; 79d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 80d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 81d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public String toXML() { 82d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen StringBuilder buf = new StringBuilder(); 83d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<").append(getElementName()).append(" xmlns=\"").append(getNamespace()).append( 84d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen "\">"); 85d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (getNode() != null) 86d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("<item node=\"").append(getNode()).append("\"/>"); 87d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen buf.append("</").append(getElementName()).append(">"); 88d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return buf.toString(); 89d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 90d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 91d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public static class Provider implements PacketExtensionProvider { 92d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 93d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 94d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Creates a new Provider. 95d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * ProviderManager requires that every PacketExtensionProvider has a public, 96d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * no-argument constructor 97d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 98d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public Provider() { 99d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 100d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 101d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen /** 102d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * Parses a OfflineMessageInfo packet (extension sub-packet). 103d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * 104d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @param parser the XML parser, positioned at the starting element of the extension. 105d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @return a PacketExtension. 106d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen * @throws Exception if a parsing error occurs. 107d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen */ 108d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen public PacketExtension parseExtension(XmlPullParser parser) 109d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen throws Exception { 110d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen OfflineMessageInfo info = new OfflineMessageInfo(); 111d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen boolean done = false; 112d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen while (!done) { 113d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen int eventType = parser.next(); 114d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (eventType == XmlPullParser.START_TAG) { 115d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (parser.getName().equals("item")) 116d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen info.setNode(parser.getAttributeValue("", "node")); 117d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } else if (eventType == XmlPullParser.END_TAG) { 118d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen if (parser.getName().equals("offline")) { 119d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen done = true; 120d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 121d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 122d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 123d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 124d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen return info; 125d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 126d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen 127d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen } 128d7955ce24d294fb2014c59d11fca184471056f44Shuyi Chen} 129