Push Notifications (XEP-0357) implementation

Fixes SMACK-738

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/PushNotificationsManager.java

@@ -0,0 +1,169 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.push_notifications;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.WeakHashMap;
+
+import org.jivesoftware.smack.ConnectionCreationListener;
+import org.jivesoftware.smack.Manager;
+import org.jivesoftware.smack.SmackException.NoResponseException;
+import org.jivesoftware.smack.SmackException.NotConnectedException;
+import org.jivesoftware.smack.XMPPConnection;
+import org.jivesoftware.smack.XMPPConnectionRegistry;
+import org.jivesoftware.smack.XMPPException.XMPPErrorException;
+import org.jivesoftware.smack.packet.IQ;
+import org.jivesoftware.smack.packet.IQ.Type;
+import org.jivesoftware.smackx.disco.ServiceDiscoveryManager;
+import org.jivesoftware.smackx.push_notifications.element.DisablePushNotificationsIQ;
+import org.jivesoftware.smackx.push_notifications.element.EnablePushNotificationsIQ;
+import org.jivesoftware.smackx.push_notifications.element.PushNotificationsElements;
+import org.jxmpp.jid.Jid;
+
+/**
+ * Push Notifications manager class.
+ * 
+ * @see <a href="http://xmpp.org/extensions/xep-0357.html">XEP-0357: Push
+ *      Notifications</a>
+ * @author Fernando Ramirez
+ * 
+ */
+public final class PushNotificationsManager extends Manager {
+
+    static {
+        XMPPConnectionRegistry.addConnectionCreationListener(new ConnectionCreationListener() {
+            @Override
+            public void connectionCreated(XMPPConnection connection) {
+                getInstanceFor(connection);
+            }
+        });
+    }
+
+    private static final Map<XMPPConnection, PushNotificationsManager> INSTANCES = new WeakHashMap<>();
+
+    /**
+     * Get the singleton instance of PushNotificationsManager.
+     *
+     * @param connection
+     * @return the instance of PushNotificationsManager
+     */
+    public static synchronized PushNotificationsManager getInstanceFor(XMPPConnection connection) {
+        PushNotificationsManager pushNotificationsManager = INSTANCES.get(connection);
+
+        if (pushNotificationsManager == null) {
+            pushNotificationsManager = new PushNotificationsManager(connection);
+            INSTANCES.put(connection, pushNotificationsManager);
+        }
+
+        return pushNotificationsManager;
+    }
+
+    private PushNotificationsManager(XMPPConnection connection) {
+        super(connection);
+    }
+
+    /**
+     * Returns true if Push Notifications is supported by the server.
+     *
+     * @return true if Push Notifications is supported by the server.
+     * @throws NoResponseException
+     * @throws XMPPErrorException
+     * @throws NotConnectedException
+     * @throws InterruptedException
+     */
+    public boolean isSupportedByServer()
+            throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        return ServiceDiscoveryManager.getInstanceFor(connection())
+                .serverSupportsFeature(PushNotificationsElements.NAMESPACE);
+    }
+
+    /**
+     * Enable push notifications.
+     * 
+     * @param pushJid
+     * @param node
+     * @return true if it was successfully enabled, false if not
+     * @throws NoResponseException
+     * @throws XMPPErrorException
+     * @throws NotConnectedException
+     * @throws InterruptedException
+     */
+    public boolean enable(Jid pushJid, String node)
+            throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        return enable(pushJid, node, null);
+    }
+
+    /**
+     * Enable push notifications.
+     * 
+     * @param pushJid
+     * @param node
+     * @param publishOptions
+     * @return true if it was successfully enabled, false if not
+     * @throws NoResponseException
+     * @throws XMPPErrorException
+     * @throws NotConnectedException
+     * @throws InterruptedException
+     */
+    public boolean enable(Jid pushJid, String node, HashMap<String, String> publishOptions)
+            throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        EnablePushNotificationsIQ enablePushNotificationsIQ = new EnablePushNotificationsIQ(pushJid, node,
+                publishOptions);
+        return changePushNotificationsStatus(enablePushNotificationsIQ);
+    }
+
+    /**
+     * Disable all push notifications.
+     * 
+     * @param pushJid
+     * @return true if it was successfully disabled, false if not
+     * @throws NoResponseException
+     * @throws XMPPErrorException
+     * @throws NotConnectedException
+     * @throws InterruptedException
+     */
+    public boolean disableAll(Jid pushJid)
+            throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        return disable(pushJid, null);
+    }
+
+    /**
+     * Disable push notifications of an specific node.
+     * 
+     * @param pushJid
+     * @param node
+     * @return true if it was successfully disabled, false if not
+     * @throws NoResponseException
+     * @throws XMPPErrorException
+     * @throws NotConnectedException
+     * @throws InterruptedException
+     */
+    public boolean disable(Jid pushJid, String node)
+            throws NoResponseException, XMPPErrorException, NotConnectedException, InterruptedException {
+        DisablePushNotificationsIQ disablePushNotificationsIQ = new DisablePushNotificationsIQ(pushJid, node);
+        return changePushNotificationsStatus(disablePushNotificationsIQ);
+    }
+
+    private boolean changePushNotificationsStatus(IQ iq)
+            throws NotConnectedException, InterruptedException, NoResponseException, XMPPErrorException {
+        final XMPPConnection connection = connection();
+        IQ responseIQ = connection.createPacketCollectorAndSend(iq).nextResultOrThrow();
+        return responseIQ.getType() != Type.error;
+    }
+
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/DisablePushNotificationsIQ.java

@@ -0,0 +1,82 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.push_notifications.element;
+
+import org.jivesoftware.smack.packet.IQ;
+import org.jxmpp.jid.Jid;
+
+/**
+ * Disable Push Notifications IQ.
+ * 
+ * @see <a href="http://xmpp.org/extensions/xep-0357.html">XEP-0357: Push
+ *      Notifications</a>
+ * @author Fernando Ramirez
+ * 
+ */
+public class DisablePushNotificationsIQ extends IQ {
+
+    /**
+     * disable element.
+     */
+    public static final String ELEMENT = "disable";
+
+    /**
+     * the IQ NAMESPACE.
+     */
+    public static final String NAMESPACE = PushNotificationsElements.NAMESPACE;
+
+    private final Jid jid;
+    private final String node;
+
+    public DisablePushNotificationsIQ(Jid jid, String node) {
+        super(ELEMENT, NAMESPACE);
+        this.jid = jid;
+        this.node = node;
+        this.setType(Type.set);
+    }
+
+    public DisablePushNotificationsIQ(Jid jid) {
+        this(jid, null);
+    }
+
+    /**
+     * Get the JID.
+     * 
+     * @return the JID
+     */
+    public Jid getJid() {
+        return jid;
+    }
+
+    /**
+     * Get the node.
+     * 
+     * @return the node
+     */
+    public String getNode() {
+        return node;
+    }
+
+    @Override
+    protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
+        xml.attribute("jid", jid);
+        xml.optAttribute("node", node);
+        xml.rightAngleBracket();
+        return xml;
+    }
+
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/EnablePushNotificationsIQ.java

@@ -0,0 +1,119 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.push_notifications.element;
+
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Map;
+
+import org.jivesoftware.smack.packet.IQ;
+import org.jivesoftware.smackx.pubsub.packet.PubSub;
+import org.jivesoftware.smackx.xdata.FormField;
+import org.jivesoftware.smackx.xdata.packet.DataForm;
+import org.jxmpp.jid.Jid;
+
+/**
+ * Enable Push Notifications IQ.
+ * 
+ * @see <a href="http://xmpp.org/extensions/xep-0357.html">XEP-0357: Push
+ *      Notifications</a>
+ * @author Fernando Ramirez
+ * 
+ */
+public class EnablePushNotificationsIQ extends IQ {
+
+    /**
+     * enable element.
+     */
+    public static final String ELEMENT = "enable";
+
+    /**
+     * the IQ NAMESPACE.
+     */
+    public static final String NAMESPACE = PushNotificationsElements.NAMESPACE;
+
+    private final Jid jid;
+    private final String node;
+    private final HashMap<String, String> publishOptions;
+
+    public EnablePushNotificationsIQ(Jid jid, String node, HashMap<String, String> publishOptions) {
+        super(ELEMENT, NAMESPACE);
+        this.jid = jid;
+        this.node = node;
+        this.publishOptions = publishOptions;
+        this.setType(Type.set);
+    }
+
+    public EnablePushNotificationsIQ(Jid jid, String node) {
+        this(jid, node, null);
+    }
+
+    /**
+     * Get the JID.
+     * 
+     * @return the JID
+     */
+    public Jid getJid() {
+        return jid;
+    }
+
+    /**
+     * Get the node.
+     * 
+     * @return the node
+     */
+    public String getNode() {
+        return node;
+    }
+
+    /**
+     * Get the publish options.
+     * 
+     * @return the publish options
+     */
+    public HashMap<String, String> getPublishOptions() {
+        return publishOptions;
+    }
+
+    @Override
+    protected IQChildElementXmlStringBuilder getIQChildElementBuilder(IQChildElementXmlStringBuilder xml) {
+        xml.attribute("jid", jid);
+        xml.attribute("node", node);
+        xml.rightAngleBracket();
+
+        if (publishOptions != null) {
+            DataForm dataForm = new DataForm(DataForm.Type.form);
+
+            FormField formTypeField = new FormField("FORM_TYPE");
+            formTypeField.addValue(PubSub.NAMESPACE + "#publish-options");
+            dataForm.addField(formTypeField);
+
+            Iterator<Map.Entry<String, String>> publishOptionsIterator = publishOptions.entrySet().iterator();
+            while (publishOptionsIterator.hasNext()) {
+                Map.Entry<String, String> pairVariableValue = publishOptionsIterator.next();
+                FormField field = new FormField(pairVariableValue.getKey());
+                field.addValue(pairVariableValue.getValue());
+                dataForm.addField(field);
+            }
+
+            xml.element(dataForm);
+        }
+
+        return xml;
+    }
+
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/PushNotificationsElements.java

@@ -0,0 +1,100 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.push_notifications.element;
+
+import org.jivesoftware.smack.packet.ExtensionElement;
+import org.jivesoftware.smack.packet.Message;
+import org.jivesoftware.smack.util.XmlStringBuilder;
+import org.jivesoftware.smackx.pubsub.packet.PubSub;
+import org.jxmpp.jid.Jid;
+
+/**
+ * Push Notifications elements.
+ * 
+ * @see <a href="http://xmpp.org/extensions/xep-0357.html">XEP-0357: Push
+ *      Notifications</a>
+ * @author Fernando Ramirez
+ * 
+ */
+public class PushNotificationsElements {
+
+    public static final String NAMESPACE = "urn:xmpp:push:0";
+
+    public static class RemoteDisablingExtension implements ExtensionElement {
+
+        public static final String NAMESPACE = PubSub.NAMESPACE;
+        public static final String ELEMENT = PubSub.ELEMENT;
+
+        private final String node;
+        private final Jid userJid;
+
+        public RemoteDisablingExtension(String node, Jid userJid) {
+            this.node = node;
+            this.userJid = userJid;
+        }
+
+        @Override
+        public String getElementName() {
+            return PubSub.ELEMENT;
+        }
+
+        @Override
+        public String getNamespace() {
+            return PubSub.NAMESPACE;
+        }
+
+        /**
+         * Get the node.
+         * 
+         * @return the node
+         */
+        public String getNode() {
+            return node;
+        }
+
+        /**
+         * Get the user JID.
+         * 
+         * @return the user JID
+         */
+        public Jid getUserJid() {
+            return userJid;
+        }
+
+        @Override
+        public CharSequence toXML() {
+            XmlStringBuilder xml = new XmlStringBuilder(this);
+
+            xml.attribute("node", node);
+            xml.rightAngleBracket();
+
+            xml.halfOpenElement("affiliation");
+            xml.attribute("jid", userJid);
+            xml.attribute("affiliation", "none");
+            xml.closeEmptyElement();
+
+            xml.closeElement(this);
+            return xml;
+        }
+
+        public static RemoteDisablingExtension from(Message message) {
+            return message.getExtension(ELEMENT, NAMESPACE);
+        }
+
+    }
+
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/element/package-info.java

@@ -0,0 +1,20 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.
+ */
+/**
+ * Push Notifications elements (XEP-0357).
+ */
+package org.jivesoftware.smackx.push_notifications.element;

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/package-info.java

@@ -0,0 +1,20 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.
+ */
+/**
+ * Classes and interfaces to manage Push Notifications (XEP-0357).
+ */
+package org.jivesoftware.smackx.push_notifications;

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/provider/RemoteDisablingProvider.java

@@ -0,0 +1,60 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.push_notifications.provider;
+
+import org.jivesoftware.smack.provider.ExtensionElementProvider;
+import org.jivesoftware.smackx.push_notifications.element.PushNotificationsElements.RemoteDisablingExtension;
+import org.jxmpp.jid.Jid;
+import org.jxmpp.jid.impl.JidCreate;
+import org.xmlpull.v1.XmlPullParser;
+
+/**
+ * Push Notifications Remote Disabling Provider class.
+ * 
+ * @see <a href="http://xmpp.org/extensions/xep-0357.html">XEP-0357: Push
+ *      Notifications</a>
+ * @author Fernando Ramirez
+ */
+public class RemoteDisablingProvider extends ExtensionElementProvider<RemoteDisablingExtension> {
+
+    @Override
+    public RemoteDisablingExtension parse(XmlPullParser parser, int initialDepth) throws Exception {
+        Jid userJid = null;
+        String node = parser.getAttributeValue("", "node");
+
+        outerloop: while (true) {
+            int eventType = parser.next();
+            if (eventType == XmlPullParser.START_TAG) {
+                if (parser.getName().equals("affiliation")) {
+                    userJid = JidCreate.from(parser.getAttributeValue("", "jid"));
+
+                    String affiliation = parser.getAttributeValue("", "affiliation");
+                    if (affiliation == null || !affiliation.equals("none")) {
+                        return null;
+                    }
+                }
+            } else if (eventType == XmlPullParser.END_TAG) {
+                if (parser.getDepth() == initialDepth) {
+                    break outerloop;
+                }
+            }
+        }
+
+        return new RemoteDisablingExtension(node, userJid);
+    }
+
+}

smack-experimental/src/main/java/org/jivesoftware/smackx/push_notifications/provider/package-info.java

@@ -0,0 +1,20 @@
+/**
+ *
+ * Copyright © 2016 Fernando Ramirez
+ *
+ * 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.
+ */
+/**
+ * Push Notifications providers (XEP-0357).
+ */
+package org.jivesoftware.smackx.push_notifications.provider;

smack-experimental/src/main/resources/org.jivesoftware.smack.experimental/experimental.providers

@@ -171,5 +171,12 @@
       <namespace>urn:xmpp:iot:control</namespace>
       <className>org.jivesoftware.smackx.iot.control.provider.IoTSetResponseProvider</className>
     </iqProvider>
-    
+
+    <!-- XEP-0357 Push Notifications -->
+    <extensionProvider>
+        <elementName>pubsub</elementName>
+        <namespace>http://jabber.org/protocol/pubsub</namespace>
+        <className>org.jivesoftware.smackx.push_notifications.provider.RemoteDisablingProvider</className>
+    </extensionProvider>
+
 </smackProviders>