mirror of
https://github.com/vanitasvitae/Smack.git
synced 2024-09-26 17:49:33 +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.
101 lines
3.2 KiB
Java
101 lines
3.2 KiB
Java
/**
|
|
*
|
|
* Copyright 2013-2014 the original author or authors
|
|
*
|
|
* 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.receipts;
|
|
|
|
import java.io.IOException;
|
|
|
|
import org.jivesoftware.smack.packet.Message;
|
|
import org.jivesoftware.smack.packet.Packet;
|
|
import org.jivesoftware.smack.packet.PacketExtension;
|
|
import org.jivesoftware.smack.provider.PacketExtensionProvider;
|
|
import org.xmlpull.v1.XmlPullParser;
|
|
import org.xmlpull.v1.XmlPullParserException;
|
|
|
|
/**
|
|
* Represents a <b>message delivery receipt request</b> entry as specified by
|
|
* <a href="http://xmpp.org/extensions/xep-0184.html">Message Delivery Receipts</a>.
|
|
*
|
|
* @author Georg Lukas
|
|
*/
|
|
public class DeliveryReceiptRequest implements PacketExtension
|
|
{
|
|
public static final String ELEMENT = "request";
|
|
|
|
public String getElementName()
|
|
{
|
|
return ELEMENT;
|
|
}
|
|
|
|
public String getNamespace()
|
|
{
|
|
return DeliveryReceipt.NAMESPACE;
|
|
}
|
|
|
|
public String toXML()
|
|
{
|
|
return "<request xmlns='" + DeliveryReceipt.NAMESPACE + "'/>";
|
|
}
|
|
|
|
/**
|
|
* Get the {@link DeliveryReceiptRequest} extension of the packet, if any.
|
|
*
|
|
* @param p the packet
|
|
* @return the {@link DeliveryReceiptRequest} extension or {@code null}
|
|
* @deprecated use {@link #from(Packet)} instead
|
|
*/
|
|
@Deprecated
|
|
public static DeliveryReceiptRequest getFrom(Packet p) {
|
|
return from(p);
|
|
}
|
|
|
|
/**
|
|
* Get the {@link DeliveryReceiptRequest} extension of the packet, if any.
|
|
*
|
|
* @param packet the packet
|
|
* @return the {@link DeliveryReceiptRequest} extension or {@code null}
|
|
*/
|
|
public static DeliveryReceiptRequest from(Packet packet) {
|
|
return packet.getExtension(ELEMENT, DeliveryReceipt.NAMESPACE);
|
|
}
|
|
|
|
/**
|
|
* Add a delivery receipt request to an outgoing packet.
|
|
*
|
|
* Only message packets may contain receipt requests as of XEP-0184,
|
|
* therefore only allow Message as the parameter type.
|
|
*
|
|
* @param message Message object to add a request to
|
|
* @return the Message ID which will be used as receipt ID
|
|
*/
|
|
public static String addTo(Message message) {
|
|
message.addExtension(new DeliveryReceiptRequest());
|
|
return message.getPacketID();
|
|
}
|
|
|
|
/**
|
|
* This Provider parses and returns DeliveryReceiptRequest packets.
|
|
*/
|
|
public static class Provider extends PacketExtensionProvider<DeliveryReceiptRequest> {
|
|
@Override
|
|
public DeliveryReceiptRequest parse(XmlPullParser parser,
|
|
int initialDepth) throws XmlPullParserException,
|
|
IOException {
|
|
return new DeliveryReceiptRequest();
|
|
}
|
|
}
|
|
}
|