Adds ForceShutdown IQ.

3 files changed, 143 insertions, 45 deletions

diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ColibriIQProvider.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ColibriIQProvider.java
index 016d9b7..cc6d0c9 100644
--- a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ColibriIQProvider.java
+++ b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ColibriIQProvider.java
@@ -87,8 +87,12 @@ public class ColibriIQProvider
                 parameterProvider);
         // Shutdown IQ
         smackInteroperabilityLayer.addIQProvider(
-                GracefulShutdownIQ.ELEMENT_NAME,
-                GracefulShutdownIQ.NAMESPACE,
+                ShutdownIQ.GRACEFUL_ELEMENT_NAME,
+                ShutdownIQ.NAMESPACE,
+                this);
+        smackInteroperabilityLayer.addIQProvider(
+                ShutdownIQ.FORCE_ELEMENT_NAME,
+                ShutdownIQ.NAMESPACE,
                 this);
         // Shutdown extension
         PacketExtensionProvider shutdownProvider
@@ -810,12 +814,12 @@ public class ColibriIQProvider
 
             iq = conference;
         }
-        else if (GracefulShutdownIQ.ELEMENT_NAME.equals(parser.getName())
-                    && GracefulShutdownIQ.NAMESPACE.equals(namespace))
+        else if (ShutdownIQ.NAMESPACE.equals(namespace) &&
+                 ShutdownIQ.isValidElementName(parser.getName()))
         {
             String rootElement = parser.getName();
 
-            iq = new GracefulShutdownIQ();
+            iq = ShutdownIQ.createShutdownIQ(rootElement);
 
             boolean done = false;
 
diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/GracefulShutdownIQ.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/GracefulShutdownIQ.java
deleted file mode 100644
index 9808b11..0000000
--- a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/GracefulShutdownIQ.java
+++ /dev/null
@@ -1,40 +0,0 @@
-/*
- * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
- *
- * Copyright @ 2015 Atlassian Pty Ltd
- *
- * 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 net.java.sip.communicator.impl.protocol.jabber.extensions.colibri;
-
-import org.jivesoftware.smack.packet.*;
-
-/**
- * The IQ used to trigger the graceful shutdown mode of the videobridge which
- * receives the stanza(given that source JID is authorized to start it).
- *
- * @author Pawel Domas
- */
-public class GracefulShutdownIQ
-    extends IQ
-{
-    public static final String NAMESPACE = ColibriConferenceIQ.NAMESPACE;
-
-    public static final String ELEMENT_NAME = "graceful-shutdown";
-
-    @Override
-    public String getChildElementXML()
-    {
-        return "<" + ELEMENT_NAME + " xmlns='" + NAMESPACE + "' />";
-    }
-}
diff --git a/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ShutdownIQ.java b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ShutdownIQ.java
new file mode 100644
index 0000000..4df251b
--- /dev/null
+++ b/src/net/java/sip/communicator/impl/protocol/jabber/extensions/colibri/ShutdownIQ.java
@@ -0,0 +1,134 @@
+/*
+ * Jitsi, the OpenSource Java VoIP and Instant Messaging client.
+ *
+ * Copyright @ 2015 Atlassian Pty Ltd
+ *
+ * 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 net.java.sip.communicator.impl.protocol.jabber.extensions.colibri;
+
+import org.jivesoftware.smack.packet.*;
+
+/**
+ * The IQ used to trigger the graceful shutdown mode of the videobridge or force
+ * shutdown the one which receives the stanza(given that source JID is
+ * authorized to do so).
+ *
+ * @author Pawel Domas
+ */
+public class ShutdownIQ
+    extends IQ
+{
+    /**
+     * XML namespace name for shutdown IQs.
+     */
+    final static public String NAMESPACE = ColibriConferenceIQ.NAMESPACE;
+
+    /**
+     * Force shutdown IQ element name.
+     */
+    final static public String FORCE_ELEMENT_NAME = "force-shutdown";
+
+    /**
+     * Graceful shutdown IQ element name.
+     */
+    final static public String GRACEFUL_ELEMENT_NAME = "graceful-shutdown";
+
+    /**
+     * The element name of this IQ. Either {@link #FORCE_ELEMENT_NAME} or
+     * {@link #GRACEFUL_ELEMENT_NAME}.
+     */
+    private final String elementName;
+
+    /**
+     * Checks if given element is a valid one for <tt>ShutdownIQ</tt>.
+     *
+     * @param elementName the name if XML element name inside of the IQ.
+     *
+     * @return <tt>true</tt> if given <tt>elementName</tt> is correct for
+     *         <tt>ShutdownIQ</tt>.
+     */
+    public static boolean isValidElementName(String elementName)
+    {
+        return GRACEFUL_ELEMENT_NAME.equals(elementName)
+            || FORCE_ELEMENT_NAME.equals(elementName);
+    }
+
+    /**
+     * Creates shutdown IQ for given element name.
+     *
+     * @param elementName can be {@link #FORCE_ELEMENT_NAME} or
+     *        {@link #GRACEFUL_ELEMENT_NAME}
+     *
+     * @return new <tt>ShutdownIQ</tt> instance for given element name.
+     *
+     * @throws IllegalArgumentException if given element name is neither
+     *         {@link #FORCE_ELEMENT_NAME} nor {@link #GRACEFUL_ELEMENT_NAME}.
+     */
+    public static ShutdownIQ createShutdownIQ(String elementName)
+    {
+        if (!isValidElementName(elementName))
+        {
+            throw new IllegalArgumentException(
+                "Invalid element name: " + elementName);
+        }
+
+        if (GRACEFUL_ELEMENT_NAME.equals(elementName))
+        {
+            return createGracefulShutdownIQ();
+        }
+        else
+        {
+            return createForceShutdownIQ();
+        }
+    }
+
+    /**
+     * Creates and returns new instance of graceful shutdown IQ.
+     */
+    public static ShutdownIQ createGracefulShutdownIQ()
+    {
+        return new ShutdownIQ(GRACEFUL_ELEMENT_NAME);
+    }
+
+    /**
+     * Creates and returns new instance of force shutdown IQ.
+     */
+    public static ShutdownIQ createForceShutdownIQ()
+    {
+        return new ShutdownIQ(FORCE_ELEMENT_NAME);
+    }
+
+    private ShutdownIQ(String elementName)
+    {
+        this.elementName = elementName;
+    }
+
+    /**
+     * Returns <tt>true</tt> if this IQ instance is a "graceful shutdown" one.
+     * Otherwise it is a force shutdown IQ.
+     */
+    public boolean isGracefulShutdown()
+    {
+        return elementName.equals(GRACEFUL_ELEMENT_NAME);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public String getChildElementXML()
+    {
+        return "<" + elementName + " xmlns='" + NAMESPACE + "' />";
+    }
+}