aboutsummaryrefslogtreecommitdiff
path: root/src/org/jivesoftware/smackx/carbons/CarbonManager.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/carbons/CarbonManager.java
parent8f4ce9ea0de51fee918bffe19c434612d6bbb2d7 (diff)
downloadsmack-d7955ce24d294fb2014c59d11fca184471056f44.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/carbons/CarbonManager.java')
-rw-r--r--src/org/jivesoftware/smackx/carbons/CarbonManager.java213
1 files changed, 213 insertions, 0 deletions
diff --git a/src/org/jivesoftware/smackx/carbons/CarbonManager.java b/src/org/jivesoftware/smackx/carbons/CarbonManager.java
new file mode 100644
index 0000000..f44701a
--- /dev/null
+++ b/src/org/jivesoftware/smackx/carbons/CarbonManager.java
@@ -0,0 +1,213 @@
+/**
+ * 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.carbons;
+
+import java.util.Collections;
+import java.util.Map;
+import java.util.WeakHashMap;
+
+import org.jivesoftware.smack.Connection;
+import org.jivesoftware.smack.ConnectionCreationListener;
+import org.jivesoftware.smack.PacketCollector;
+import org.jivesoftware.smack.PacketListener;
+import org.jivesoftware.smack.SmackConfiguration;
+import org.jivesoftware.smack.XMPPException;
+import org.jivesoftware.smack.filter.PacketIDFilter;
+import org.jivesoftware.smack.packet.IQ;
+import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.packet.Packet;
+import org.jivesoftware.smackx.ServiceDiscoveryManager;
+import org.jivesoftware.smackx.packet.DiscoverInfo;
+
+/**
+ * Packet extension for XEP-0280: Message Carbons. This class implements
+ * the manager for registering {@link Carbon} support, enabling and disabling
+ * message carbons.
+ *
+ * You should call enableCarbons() before sending your first undirected
+ * presence.
+ *
+ * @author Georg Lukas
+ */
+public class CarbonManager {
+
+ private static Map<Connection, CarbonManager> instances =
+ Collections.synchronizedMap(new WeakHashMap<Connection, CarbonManager>());
+
+ static {
+ Connection.addConnectionCreationListener(new ConnectionCreationListener() {
+ public void connectionCreated(Connection connection) {
+ new CarbonManager(connection);
+ }
+ });
+ }
+
+ private Connection connection;
+ private volatile boolean enabled_state = false;
+
+ private CarbonManager(Connection connection) {
+ ServiceDiscoveryManager sdm = ServiceDiscoveryManager.getInstanceFor(connection);
+ sdm.addFeature(Carbon.NAMESPACE);
+ this.connection = connection;
+ instances.put(connection, this);
+ }
+
+ /**
+ * Obtain the CarbonManager responsible for a connection.
+ *
+ * @param connection the connection object.
+ *
+ * @return a CarbonManager instance
+ */
+ public static CarbonManager getInstanceFor(Connection connection) {
+ CarbonManager carbonManager = instances.get(connection);
+
+ if (carbonManager == null) {
+ carbonManager = new CarbonManager(connection);
+ }
+
+ return carbonManager;
+ }
+
+ private IQ carbonsEnabledIQ(final boolean new_state) {
+ IQ setIQ = new IQ() {
+ public String getChildElementXML() {
+ return "<" + (new_state? "enable" : "disable") + " xmlns='" + Carbon.NAMESPACE + "'/>";
+ }
+ };
+ setIQ.setType(IQ.Type.SET);
+ return setIQ;
+ }
+
+ /**
+ * Returns true if XMPP Carbons are supported by the server.
+ *
+ * @return true if supported
+ */
+ public boolean isSupportedByServer() {
+ try {
+ DiscoverInfo result = ServiceDiscoveryManager
+ .getInstanceFor(connection).discoverInfo(connection.getServiceName());
+ return result.containsFeature(Carbon.NAMESPACE);
+ }
+ catch (XMPPException e) {
+ return false;
+ }
+ }
+
+ /**
+ * Notify server to change the carbons state. This method returns
+ * immediately and changes the variable when the reply arrives.
+ *
+ * You should first check for support using isSupportedByServer().
+ *
+ * @param new_state whether carbons should be enabled or disabled
+ */
+ public void sendCarbonsEnabled(final boolean new_state) {
+ IQ setIQ = carbonsEnabledIQ(new_state);
+
+ connection.addPacketListener(new PacketListener() {
+ public void processPacket(Packet packet) {
+ IQ result = (IQ)packet;
+ if (result.getType() == IQ.Type.RESULT) {
+ enabled_state = new_state;
+ }
+ connection.removePacketListener(this);
+ }
+ }, new PacketIDFilter(setIQ.getPacketID()));
+
+ connection.sendPacket(setIQ);
+ }
+
+ /**
+ * Notify server to change the carbons state. This method blocks
+ * some time until the server replies to the IQ and returns true on
+ * success.
+ *
+ * You should first check for support using isSupportedByServer().
+ *
+ * @param new_state whether carbons should be enabled or disabled
+ *
+ * @return true if the operation was successful
+ */
+ public boolean setCarbonsEnabled(final boolean new_state) {
+ if (enabled_state == new_state)
+ return true;
+
+ IQ setIQ = carbonsEnabledIQ(new_state);
+
+ PacketCollector collector =
+ connection.createPacketCollector(new PacketIDFilter(setIQ.getPacketID()));
+ connection.sendPacket(setIQ);
+ IQ result = (IQ) collector.nextResult(SmackConfiguration.getPacketReplyTimeout());
+ collector.cancel();
+
+ if (result != null && result.getType() == IQ.Type.RESULT) {
+ enabled_state = new_state;
+ return true;
+ }
+ return false;
+ }
+
+ /**
+ * Helper method to enable carbons.
+ *
+ * @return true if the operation was successful
+ */
+ public boolean enableCarbons() {
+ return setCarbonsEnabled(true);
+ }
+
+ /**
+ * Helper method to disable carbons.
+ *
+ * @return true if the operation was successful
+ */
+ public boolean disableCarbons() {
+ return setCarbonsEnabled(false);
+ }
+
+ /**
+ * Check if carbons are enabled on this connection.
+ */
+ public boolean getCarbonsEnabled() {
+ return this.enabled_state;
+ }
+
+ /**
+ * Obtain a Carbon from a message, if available.
+ *
+ * @param msg Message object to check for carbons
+ *
+ * @return a Carbon if available, null otherwise.
+ */
+ public static Carbon getCarbon(Message msg) {
+ Carbon cc = (Carbon)msg.getExtension("received", Carbon.NAMESPACE);
+ if (cc == null)
+ cc = (Carbon)msg.getExtension("sent", Carbon.NAMESPACE);
+ return cc;
+ }
+
+ /**
+ * Mark a message as "private", so it will not be carbon-copied.
+ *
+ * @param msg Message object to mark private
+ */
+ public static void disableCarbons(Message msg) {
+ msg.addExtension(new Carbon.Private());
+ }
+}