mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-06-26 05:14:49 +02:00
6980c8e63d
this is the first stop towards fixing "SMACK-65: parsing should look for depth", by providing the initial parsing depth to the provider. Some methods (.e.g parseMessage) now use the depth as abort condition, instead of a unclean String equals check. parseIQ() and parseExtension() where both renamed to parse. This also restricts the Exceptions thrown by the parse method, to just XmlPullParserException, IOException and SmackException (not really a big victory, but nevertheless a slight improvement). StreamFeatureProvider is now gone, we simply use PacketExtensionProvider for stream features.
124 lines
4.3 KiB
Java
124 lines
4.3 KiB
Java
/**
|
|
*
|
|
* Copyright 2003-2007 Jive Software.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package org.jivesoftware.smackx.offline.packet;
|
|
|
|
import java.io.IOException;
|
|
|
|
import org.jivesoftware.smack.packet.PacketExtension;
|
|
import org.jivesoftware.smack.provider.PacketExtensionProvider;
|
|
import org.xmlpull.v1.XmlPullParser;
|
|
import org.xmlpull.v1.XmlPullParserException;
|
|
|
|
/**
|
|
* OfflineMessageInfo is an extension included in the retrieved offline messages requested by
|
|
* the {@link org.jivesoftware.smackx.offline.OfflineMessageManager}. This extension includes a stamp
|
|
* that uniquely identifies the offline message. This stamp may be used for deleting the offline
|
|
* message. The stamp may be of the form UTC timestamps but it is not required to have that format.
|
|
*
|
|
* @author Gaston Dombiak
|
|
*/
|
|
public class OfflineMessageInfo implements PacketExtension {
|
|
|
|
private String node = null;
|
|
|
|
/**
|
|
* Returns the XML element name of the extension sub-packet root element.
|
|
* Always returns "offline"
|
|
*
|
|
* @return the XML element name of the packet extension.
|
|
*/
|
|
public String getElementName() {
|
|
return "offline";
|
|
}
|
|
|
|
/**
|
|
* Returns the XML namespace of the extension sub-packet root element.
|
|
* According the specification the namespace is always "http://jabber.org/protocol/offline"
|
|
*
|
|
* @return the XML namespace of the packet extension.
|
|
*/
|
|
public String getNamespace() {
|
|
return "http://jabber.org/protocol/offline";
|
|
}
|
|
|
|
/**
|
|
* Returns the stamp that uniquely identifies the offline message. This stamp may
|
|
* be used for deleting the offline message. The stamp may be of the form UTC timestamps
|
|
* but it is not required to have that format.
|
|
*
|
|
* @return the stamp that uniquely identifies the offline message.
|
|
*/
|
|
public String getNode() {
|
|
return node;
|
|
}
|
|
|
|
/**
|
|
* Sets the stamp that uniquely identifies the offline message. This stamp may
|
|
* be used for deleting the offline message. The stamp may be of the form UTC timestamps
|
|
* but it is not required to have that format.
|
|
*
|
|
* @param node the stamp that uniquely identifies the offline message.
|
|
*/
|
|
public void setNode(String node) {
|
|
this.node = node;
|
|
}
|
|
|
|
public String toXML() {
|
|
StringBuilder buf = new StringBuilder();
|
|
buf.append("<").append(getElementName()).append(" xmlns=\"").append(getNamespace()).append(
|
|
"\">");
|
|
if (getNode() != null)
|
|
buf.append("<item node=\"").append(getNode()).append("\"/>");
|
|
buf.append("</").append(getElementName()).append(">");
|
|
return buf.toString();
|
|
}
|
|
|
|
public static class Provider extends PacketExtensionProvider<OfflineMessageInfo> {
|
|
|
|
/**
|
|
* Parses a OfflineMessageInfo packet (extension sub-packet).
|
|
*
|
|
* @param parser the XML parser, positioned at the starting element of the extension.
|
|
* @return a PacketExtension.
|
|
* @throws IOException
|
|
* @throws XmlPullParserException
|
|
*/
|
|
@Override
|
|
public OfflineMessageInfo parse(XmlPullParser parser,
|
|
int initialDepth) throws XmlPullParserException,
|
|
IOException {
|
|
OfflineMessageInfo info = new OfflineMessageInfo();
|
|
boolean done = false;
|
|
while (!done) {
|
|
int eventType = parser.next();
|
|
if (eventType == XmlPullParser.START_TAG) {
|
|
if (parser.getName().equals("item"))
|
|
info.setNode(parser.getAttributeValue("", "node"));
|
|
} else if (eventType == XmlPullParser.END_TAG) {
|
|
if (parser.getName().equals("offline")) {
|
|
done = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return info;
|
|
}
|
|
|
|
}
|
|
}
|