aboutsummaryrefslogtreecommitdiff
path: root/src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
diff options
context:
space:
mode:
authorShuyi Chen <shuyichen@google.com>2013-05-22 14:51:55 -0700
committerShuyi Chen <shuyichen@google.com>2013-05-22 17:19:30 -0700
commitd7955ce24d294fb2014c59d11fca184471056f44 (patch)
treee260500b0b7639127038495d46a0ad6dcbb6d96c /src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
parent8f4ce9ea0de51fee918bffe19c434612d6bbb2d7 (diff)
downloadsmack-c0f93827c45b4d74bcc54ae85709f27055f5fbff.tar.gz
Add android smack source.HEADandroid-wear-5.0.0_r1android-sdk-4.4.2_r1.0.1android-sdk-4.4.2_r1android-l-preview_r2android-cts-5.1_r9android-cts-5.1_r8android-cts-5.1_r7android-cts-5.1_r6android-cts-5.1_r5android-cts-5.1_r4android-cts-5.1_r3android-cts-5.1_r28android-cts-5.1_r27android-cts-5.1_r26android-cts-5.1_r25android-cts-5.1_r24android-cts-5.1_r23android-cts-5.1_r22android-cts-5.1_r21android-cts-5.1_r20android-cts-5.1_r2android-cts-5.1_r19android-cts-5.1_r18android-cts-5.1_r17android-cts-5.1_r16android-cts-5.1_r15android-cts-5.1_r14android-cts-5.1_r13android-cts-5.1_r10android-cts-5.1_r1android-cts-5.0_r9android-cts-5.0_r8android-cts-5.0_r7android-cts-5.0_r6android-cts-5.0_r5android-cts-5.0_r4android-cts-5.0_r3android-cts-4.4_r4android-cts-4.4_r1android-5.1.1_r9android-5.1.1_r8android-5.1.1_r7android-5.1.1_r6android-5.1.1_r5android-5.1.1_r4android-5.1.1_r38android-5.1.1_r37android-5.1.1_r36android-5.1.1_r35android-5.1.1_r34android-5.1.1_r33android-5.1.1_r30android-5.1.1_r3android-5.1.1_r29android-5.1.1_r28android-5.1.1_r26android-5.1.1_r25android-5.1.1_r24android-5.1.1_r23android-5.1.1_r22android-5.1.1_r20android-5.1.1_r2android-5.1.1_r19android-5.1.1_r18android-5.1.1_r17android-5.1.1_r16android-5.1.1_r15android-5.1.1_r14android-5.1.1_r13android-5.1.1_r12android-5.1.1_r10android-5.1.1_r1android-5.1.0_r5android-5.1.0_r4android-5.1.0_r3android-5.1.0_r1android-5.0.2_r3android-5.0.2_r1android-5.0.1_r1android-5.0.0_r7android-5.0.0_r6android-5.0.0_r5.1android-5.0.0_r5android-5.0.0_r4android-5.0.0_r3android-5.0.0_r2android-5.0.0_r1android-4.4w_r1android-4.4_r1.2.0.1android-4.4_r1.2android-4.4_r1.1.0.1android-4.4_r1.1android-4.4_r1.0.1android-4.4_r1android-4.4_r0.9android-4.4_r0.8android-4.4_r0.7android-4.4.4_r2.0.1android-4.4.4_r2android-4.4.4_r1.0.1android-4.4.4_r1android-4.4.3_r1.1.0.1android-4.4.3_r1.1android-4.4.3_r1.0.1android-4.4.3_r1android-4.4.2_r2.0.1android-4.4.2_r2android-4.4.2_r1.0.1android-4.4.2_r1android-4.4.1_r1.0.1android-4.4.1_r1android-4.3_r3.1android-4.3_r3android-4.3_r2.3android-4.3_r2.2android-4.3_r2.1android-4.3_r2android-4.3_r1.1android-4.3_r1android-4.3_r0.9.1android-4.3_r0.9android-4.3.1_r1tools_r22.2mastermainlollipop-wear-releaselollipop-releaselollipop-mr1-wfc-releaselollipop-mr1-releaselollipop-mr1-fi-releaselollipop-mr1-devlollipop-mr1-cts-releaselollipop-devlollipop-cts-releasel-previewkitkat-wearkitkat-releasekitkat-mr2.2-releasekitkat-mr2.1-releasekitkat-mr2-releasekitkat-mr1.1-releasekitkat-mr1-releasekitkat-devkitkat-cts-releasekitkat-cts-devjb-mr2.0.0-releasejb-mr2.0-releasejb-mr2-releasejb-mr2-devidea133-weekly-releaseidea133
Change-Id: I49ce97136c17173c4ae3965c694af6e7bc49897d
Diffstat (limited to 'src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java')
-rw-r--r--src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java202
1 files changed, 202 insertions, 0 deletions
diff --git a/src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java b/src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
new file mode 100644
index 0000000..125b87e
--- /dev/null
+++ b/src/org/jivesoftware/smackx/receipts/DeliveryReceiptManager.java
@@ -0,0 +1,202 @@
+/**
+ * Copyright 2013 Georg Lukas
+ *
+ * All rights reserved. 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.util.Collections;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import java.util.WeakHashMap;
+
+import org.jivesoftware.smack.Connection;
+import org.jivesoftware.smack.ConnectionCreationListener;
+import org.jivesoftware.smack.PacketListener;
+import org.jivesoftware.smack.XMPPException;
+import org.jivesoftware.smack.filter.PacketExtensionFilter;
+import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.packet.Packet;
+import org.jivesoftware.smackx.ServiceDiscoveryManager;
+import org.jivesoftware.smackx.packet.DiscoverInfo;
+
+/**
+ * Manager for XEP-0184: Message Delivery Receipts. This class implements
+ * the manager for {@link DeliveryReceipt} support, enabling and disabling of
+ * automatic DeliveryReceipt transmission.
+ *
+ * @author Georg Lukas
+ */
+public class DeliveryReceiptManager implements PacketListener {
+
+ private static Map<Connection, DeliveryReceiptManager> instances =
+ Collections.synchronizedMap(new WeakHashMap<Connection, DeliveryReceiptManager>());
+
+ static {
+ Connection.addConnectionCreationListener(new ConnectionCreationListener() {
+ public void connectionCreated(Connection connection) {
+ new DeliveryReceiptManager(connection);
+ }
+ });
+ }
+
+ private Connection connection;
+ private boolean auto_receipts_enabled = false;
+ private Set<ReceiptReceivedListener> receiptReceivedListeners = Collections
+ .synchronizedSet(new HashSet<ReceiptReceivedListener>());
+
+ private DeliveryReceiptManager(Connection connection) {
+ ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection);
+ sdm.addFeature(DeliveryReceipt.NAMESPACE);
+ this.connection = connection;
+ instances.put(connection, this);
+
+ // register listener for delivery receipts and requests
+ connection.addPacketListener(this, new PacketExtensionFilter(DeliveryReceipt.NAMESPACE));
+ }
+
+ /**
+ * Obtain the DeliveryReceiptManager responsible for a connection.
+ *
+ * @param connection the connection object.
+ *
+ * @return the DeliveryReceiptManager instance for the given connection
+ */
+ synchronized public static DeliveryReceiptManager getInstanceFor(Connection connection) {
+ DeliveryReceiptManager receiptManager = instances.get(connection);
+
+ if (receiptManager == null) {
+ receiptManager = new DeliveryReceiptManager(connection);
+ }
+
+ return receiptManager;
+ }
+
+ /**
+ * Returns true if Delivery Receipts are supported by a given JID
+ *
+ * @param jid
+ * @return true if supported
+ */
+ public boolean isSupported(String jid) {
+ try {
+ DiscoverInfo result =
+ ServiceDiscoveryManager.getInstanceFor(connection).discoverInfo(jid);
+ return result.containsFeature(DeliveryReceipt.NAMESPACE);
+ }
+ catch (XMPPException e) {
+ return false;
+ }
+ }
+
+ // handle incoming receipts and receipt requests
+ @Override
+ public void processPacket(Packet packet) {
+ DeliveryReceipt dr = (DeliveryReceipt)packet.getExtension(
+ DeliveryReceipt.ELEMENT, DeliveryReceipt.NAMESPACE);
+ if (dr != null) {
+ // notify listeners of incoming receipt
+ for (ReceiptReceivedListener l : receiptReceivedListeners) {
+ l.onReceiptReceived(packet.getFrom(), packet.getTo(), dr.getId());
+ }
+
+ }
+
+ // if enabled, automatically send a receipt
+ if (auto_receipts_enabled) {
+ DeliveryReceiptRequest drr = (DeliveryReceiptRequest)packet.getExtension(
+ DeliveryReceiptRequest.ELEMENT, DeliveryReceipt.NAMESPACE);
+ if (drr != null) {
+ Message ack = new Message(packet.getFrom(), Message.Type.normal);
+ ack.addExtension(new DeliveryReceipt(packet.getPacketID()));
+ connection.sendPacket(ack);
+ }
+ }
+ }
+
+ /**
+ * Configure whether the {@link DeliveryReceiptManager} should automatically
+ * reply to incoming {@link DeliveryReceipt}s. By default, this feature is off.
+ *
+ * @param new_state whether automatic transmission of
+ * DeliveryReceipts should be enabled or disabled
+ */
+ public void setAutoReceiptsEnabled(boolean new_state) {
+ auto_receipts_enabled = new_state;
+ }
+
+ /**
+ * Helper method to enable automatic DeliveryReceipt transmission.
+ */
+ public void enableAutoReceipts() {
+ setAutoReceiptsEnabled(true);
+ }
+
+ /**
+ * Helper method to disable automatic DeliveryReceipt transmission.
+ */
+ public void disableAutoReceipts() {
+ setAutoReceiptsEnabled(false);
+ }
+
+ /**
+ * Check if AutoReceipts are enabled on this connection.
+ */
+ public boolean getAutoReceiptsEnabled() {
+ return this.auto_receipts_enabled;
+ }
+
+ /**
+ * Get informed about incoming delivery receipts with a {@link ReceiptReceivedListener}.
+ *
+ * @param listener the listener to be informed about new receipts
+ */
+ public void addReceiptReceivedListener(ReceiptReceivedListener listener) {
+ receiptReceivedListeners.add(listener);
+ }
+
+ /**
+ * Stop getting informed about incoming delivery receipts.
+ *
+ * @param listener the listener to be removed
+ */
+ public void removeReceiptReceivedListener(ReceiptReceivedListener listener) {
+ receiptReceivedListeners.remove(listener);
+ }
+
+ /**
+ * Test if a packet requires a delivery receipt.
+ *
+ * @param p Packet object to check for a DeliveryReceiptRequest
+ *
+ * @return true if a delivery receipt was requested
+ */
+ public static boolean hasDeliveryReceiptRequest(Packet p) {
+ return (p.getExtension(DeliveryReceiptRequest.ELEMENT,
+ DeliveryReceipt.NAMESPACE) != null);
+ }
+
+ /**
+ * 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 m Message object to add a request to
+ */
+ public static void addDeliveryReceiptRequest(Message m) {
+ m.addExtension(new DeliveryReceiptRequest());
+ }
+}