Allow customizing client-side push config on server side (#11867)

Change-Id: I212067aa0bd04e3e73844ef57963b5622291986a

5 files changed, 294 insertions, 49 deletions

diff --git a/server/src/com/vaadin/server/VaadinSession.java b/server/src/com/vaadin/server/VaadinSession.java
index 889eadcd6f..e0a5b51baa 100644
--- a/server/src/com/vaadin/server/VaadinSession.java
+++ b/server/src/com/vaadin/server/VaadinSession.java
@@ -902,7 +902,7 @@ public class VaadinSession implements HttpSessionBindingListener, Serializable {
                 getService().runPendingAccessTasks(this);
 
                 for (UI ui : getUIs()) {
-                    if (ui.getPushMode() == PushMode.AUTOMATIC) {
+                    if (ui.getPushConfiguration().getPushMode() == PushMode.AUTOMATIC) {
                         ui.push();
                     }
                 }
diff --git a/server/src/com/vaadin/server/communication/PushHandler.java b/server/src/com/vaadin/server/communication/PushHandler.java
index a44df79221..7efcb8fd8c 100644
--- a/server/src/com/vaadin/server/communication/PushHandler.java
+++ b/server/src/com/vaadin/server/communication/PushHandler.java
@@ -171,7 +171,7 @@ public class PushHandler implements AtmosphereHandler {
     PushEventCallback disconnectCallback = new PushEventCallback() {
         @Override
         public void run(AtmosphereResource resource, UI ui) throws IOException {
-            PushMode pushMode = ui.getPushMode();
+            PushMode pushMode = ui.getPushConfiguration().getPushMode();
             AtmospherePushConnection pushConnection = getConnectionForUI(ui);
 
             String id = resource.uuid();
diff --git a/server/src/com/vaadin/server/communication/UIInitHandler.java b/server/src/com/vaadin/server/communication/UIInitHandler.java
index 8507bf40cc..9807ea6a9f 100644
--- a/server/src/com/vaadin/server/communication/UIInitHandler.java
+++ b/server/src/com/vaadin/server/communication/UIInitHandler.java
@@ -209,7 +209,7 @@ public abstract class UIInitHandler extends SynchronizedRequestHandler {
             pushMode = session.getService().getDeploymentConfiguration()
                     .getPushMode();
         }
-        ui.setPushMode(pushMode);
+        ui.getPushConfiguration().setPushMode(pushMode);
 
         // Set thread local here so it is available in init
         UI.setCurrent(ui);
diff --git a/server/src/com/vaadin/ui/PushConfiguration.java b/server/src/com/vaadin/ui/PushConfiguration.java
new file mode 100644
index 0000000000..a592b39bef
--- /dev/null
+++ b/server/src/com/vaadin/ui/PushConfiguration.java
@@ -0,0 +1,282 @@
+/*
+ * Copyright 2000-2013 Vaadin 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 com.vaadin.ui;
+
+import java.io.Serializable;
+import java.util.Collection;
+import java.util.Collections;
+
+import com.vaadin.server.VaadinSession;
+import com.vaadin.shared.communication.PushMode;
+import com.vaadin.shared.ui.ui.Transport;
+import com.vaadin.shared.ui.ui.UIState.PushConfigurationState;
+
+/**
+ * Provides method for configuring the push channel.
+ * 
+ * @since 7.1
+ * @author Vaadin Ltd
+ */
+public interface PushConfiguration extends Serializable {
+
+    /**
+     * Returns the mode of bidirectional ("push") communication that is used.
+     * 
+     * @return The push mode.
+     */
+    public PushMode getPushMode();
+
+    /**
+     * Sets the mode of bidirectional ("push") communication that should be
+     * used.
+     * <p>
+     * Add-on developers should note that this method is only meant for the
+     * application developer. An add-on should not set the push mode directly,
+     * rather instruct the user to set it.
+     * </p>
+     * 
+     * @param pushMode
+     *            The push mode to use.
+     * 
+     * @throws IllegalArgumentException
+     *             if the argument is null.
+     * @throws IllegalStateException
+     *             if push support is not available.
+     */
+    public void setPushMode(PushMode pushMode);
+
+    /**
+     * Returns the primary transport type for push.
+     * <p>
+     * Note that if you set the transport type using
+     * {@link #setParameter(String, String)} to an unsupported type this method
+     * will return null. Supported types are defined by {@link Transport}.
+     * 
+     * @return The primary transport type
+     */
+    public Transport getTransport();
+
+    /**
+     * Sets the primary transport type for push.
+     * <p>
+     * Note that the new transport type will not be used until the push channel
+     * is disconnected and reconnected if already active.
+     * 
+     * @param transport
+     *            The primary transport type
+     */
+    public void setTransport(Transport transport);
+
+    /**
+     * Returns the fallback transport type for push.
+     * <p>
+     * Note that if you set the transport type using
+     * {@link #setParameter(String, String)} to an unsupported type this method
+     * will return null. Supported types are defined by {@link Transport}.
+     * 
+     * @return The fallback transport type
+     */
+    public Transport getFallbackTransport();
+
+    /**
+     * Sets the fallback transport type for push.
+     * <p>
+     * Note that the new transport type will not be used until the push channel
+     * is disconnected and reconnected if already active.
+     * 
+     * @param fallbackTransport
+     *            The fallback transport type
+     */
+    public void setFallbackTransport(Transport fallbackTransport);
+
+    /**
+     * Returns the given parameter, if set.
+     * <p>
+     * This method provides low level access to push parameters and is typically
+     * not needed for normal application development.
+     * 
+     * @since 7.1
+     * @param parameter
+     *            The parameter name
+     * @return The parameter value or null if not set
+     */
+    public String getParameter(String parameter);
+
+    /**
+     * Returns the parameters which have been defined.
+     * 
+     * @since 7.1
+     * @return A collection of parameter names
+     */
+    public Collection<String> getParameterNames();
+
+    /**
+     * Sets the given parameter.
+     * <p>
+     * This method provides low level access to push parameters and is typically
+     * not needed for normal application development.
+     * 
+     * @since 7.1
+     * @param parameter
+     *            The parameter name
+     * @param value
+     *            The value
+     */
+    public void setParameter(String parameter, String value);
+
+}
+
+class PushConfigurationImpl implements PushConfiguration {
+    private UI ui;
+
+    public PushConfigurationImpl(UI ui) {
+        this.ui = ui;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.PushConfiguration#getPushMode()
+     */
+    @Override
+    public PushMode getPushMode() {
+        return getState(false).mode;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.PushConfiguration#setPushMode(com.vaadin.shared.communication
+     * .PushMode)
+     */
+    @Override
+    public void setPushMode(PushMode pushMode) {
+        if (pushMode == null) {
+            throw new IllegalArgumentException("Push mode cannot be null");
+        }
+
+        if (pushMode.isEnabled()) {
+            VaadinSession session = ui.getSession();
+            if (session != null && !session.getService().ensurePushAvailable()) {
+                throw new IllegalStateException(
+                        "Push is not available. See previous log messages for more information.");
+            }
+        }
+
+        /*
+         * Client-side will open a new connection or disconnect the old
+         * connection, so there's nothing more to do on the server at this
+         * point.
+         */
+        getState().mode = pushMode;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.PushConfiguration#getTransport()
+     */
+    @Override
+    public Transport getTransport() {
+        try {
+            return Transport
+                    .valueOf(getParameter(PushConfigurationState.TRANSPORT_PARAM));
+        } catch (IllegalArgumentException e) {
+            return null;
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.PushConfiguration#setTransport(com.vaadin.shared.ui.ui.
+     * Transport)
+     */
+    @Override
+    public void setTransport(Transport transport) {
+        setParameter(PushConfigurationState.TRANSPORT_PARAM,
+                transport.getIdentifier());
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.PushConfiguration#getFallbackTransport()
+     */
+    @Override
+    public Transport getFallbackTransport() {
+        try {
+            return Transport
+                    .valueOf(getParameter(PushConfigurationState.FALLBACK_TRANSPORT_PARAM));
+        } catch (IllegalArgumentException e) {
+            return null;
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.PushConfiguration#setFallbackTransport(com.vaadin.shared
+     * .ui.ui.Transport)
+     */
+    @Override
+    public void setFallbackTransport(Transport fallbackTransport) {
+        setParameter(PushConfigurationState.FALLBACK_TRANSPORT_PARAM,
+                fallbackTransport.getIdentifier());
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.PushConfiguration#getParameter(java.lang.String)
+     */
+    @Override
+    public String getParameter(String parameter) {
+        return getState(false).parameters.get(parameter);
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.PushConfiguration#setParameter(java.lang.String,
+     * java.lang.String)
+     */
+    @Override
+    public void setParameter(String parameter, String value) {
+        getState().parameters.put(parameter, value);
+
+    }
+
+    private PushConfigurationState getState() {
+        return ui.getState().pushConfiguration;
+    }
+
+    private PushConfigurationState getState(boolean markAsDirty) {
+        return ui.getState(markAsDirty).pushConfiguration;
+    }
+
+    @Override
+    public Collection<String> getParameterNames() {
+        return Collections
+                .unmodifiableCollection(ui.getState(false).pushConfiguration.parameters
+                        .keySet());
+    }
+
+}
diff --git a/server/src/com/vaadin/ui/UI.java b/server/src/com/vaadin/ui/UI.java
index 2c6283377a..6159298a69 100644
--- a/server/src/com/vaadin/ui/UI.java
+++ b/server/src/com/vaadin/ui/UI.java
@@ -48,7 +48,6 @@ import com.vaadin.server.communication.PushConnection;
 import com.vaadin.shared.Connector;
 import com.vaadin.shared.EventId;
 import com.vaadin.shared.MouseEventDetails;
-import com.vaadin.shared.communication.PushMode;
 import com.vaadin.shared.ui.ui.DebugWindowClientRpc;
 import com.vaadin.shared.ui.ui.DebugWindowServerRpc;
 import com.vaadin.shared.ui.ui.ScrollClientRpc;
@@ -216,6 +215,8 @@ public abstract class UI extends AbstractSingleComponentContainer implements
 
     private TooltipConfiguration tooltipConfiguration = new TooltipConfigurationImpl(
             this);
+    private PushConfiguration pushConfiguration = new PushConfigurationImpl(
+            this);
 
     /**
      * Creates a new empty UI without a caption. The content of the UI must be
@@ -1325,7 +1326,7 @@ public abstract class UI extends AbstractSingleComponentContainer implements
                 return;
             }
 
-            if (!getPushMode().isEnabled()) {
+            if (!getPushConfiguration().getPushMode().isEnabled()) {
                 throw new IllegalStateException("Push not enabled");
             }
 
@@ -1353,7 +1354,7 @@ public abstract class UI extends AbstractSingleComponentContainer implements
      */
     public void setPushConnection(PushConnection pushConnection) {
         // If pushMode is disabled then there should never be a pushConnection
-        assert (getPushMode().isEnabled() || pushConnection == null);
+        assert (getPushConfiguration().getPushMode().isEnabled() || pushConnection == null);
 
         if (pushConnection == this.pushConnection) {
             return;
@@ -1402,51 +1403,13 @@ public abstract class UI extends AbstractSingleComponentContainer implements
     }
 
     /**
-     * Returns the mode of bidirectional ("push") communication that is used in
-     * this UI.
-     * 
-     * @return The push mode.
-     */
-    public PushMode getPushMode() {
-        return getState(false).pushMode;
-    }
-
-    /**
-     * Sets the mode of bidirectional ("push") communication that should be used
-     * in this UI.
-     * <p>
-     * Add-on developers should note that this method is only meant for the
-     * application developer. An add-on should not set the push mode directly,
-     * rather instruct the user to set it.
-     * </p>
+     * Retrieves the object used for configuring the push channel.
      * 
-     * @param pushMode
-     *            The push mode to use.
-     * 
-     * @throws IllegalArgumentException
-     *             if the argument is null.
-     * @throws IllegalStateException
-     *             if push support is not available.
+     * @since 7.1
+     * @return The instance used for push configuration
      */
-    public void setPushMode(PushMode pushMode) {
-        if (pushMode == null) {
-            throw new IllegalArgumentException("Push mode cannot be null");
-        }
-
-        if (pushMode.isEnabled()) {
-            VaadinSession session = getSession();
-            if (session != null && !session.getService().ensurePushAvailable()) {
-                throw new IllegalStateException(
-                        "Push is not available. See previous log messages for more information.");
-            }
-        }
-
-        /*
-         * Client-side will open a new connection or disconnect the old
-         * connection, so there's nothing more to do on the server at this
-         * point.
-         */
-        getState().pushMode = pushMode;
+    public PushConfiguration getPushConfiguration() {
+        return pushConfiguration;
     }
 
     /**