Move LegacyApplication to its own file (#9402)

6 files changed, 311 insertions, 282 deletions

diff --git a/server/src/com/vaadin/Application.java b/server/src/com/vaadin/Application.java
index 634f96bfe1..2baf252a62 100644
--- a/server/src/com/vaadin/Application.java
+++ b/server/src/com/vaadin/Application.java
@@ -31,19 +31,15 @@ import java.util.LinkedList;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
-import java.util.Map.Entry;
 import java.util.Properties;
 import java.util.logging.Level;
 import java.util.logging.Logger;
-import java.util.regex.Matcher;
-import java.util.regex.Pattern;
 
 import com.vaadin.data.util.converter.Converter;
 import com.vaadin.data.util.converter.ConverterFactory;
 import com.vaadin.data.util.converter.DefaultConverterFactory;
 import com.vaadin.event.EventRouter;
 import com.vaadin.server.AbstractErrorMessage;
-import com.vaadin.server.AbstractUIProvider;
 import com.vaadin.server.ApplicationConfiguration;
 import com.vaadin.server.ApplicationContext;
 import com.vaadin.server.BootstrapFragmentResponse;
@@ -58,8 +54,6 @@ import com.vaadin.server.GlobalResourceHandler;
 import com.vaadin.server.RequestHandler;
 import com.vaadin.server.ServletApplicationContext;
 import com.vaadin.server.Terminal;
-import com.vaadin.server.Terminal.ErrorEvent;
-import com.vaadin.server.Terminal.ErrorListener;
 import com.vaadin.server.UIProvider;
 import com.vaadin.server.VaadinServlet;
 import com.vaadin.server.VariableOwner;
@@ -143,278 +137,6 @@ public class Application implements Terminal.ErrorListener, Serializable {
                     BootstrapPageResponse.class);
 
     /**
-     * A special application designed to help migrating applications from Vaadin
-     * 6 to Vaadin 7. The legacy application supports setting a main window,
-     * adding additional browser level windows and defining the theme for the
-     * entire application.
-     * 
-     * @deprecated This class is only intended to ease migration and should not
-     *             be used for new projects.
-     * 
-     * @since 7.0
-     */
-    @Deprecated
-    public static abstract class LegacyApplication extends AbstractUIProvider
-            implements ErrorListener {
-        /**
-         * Ignore initial / and then get everything up to the next /
-         */
-        private static final Pattern WINDOW_NAME_PATTERN = Pattern
-                .compile("^/?([^/]+).*");
-
-        private UI.LegacyWindow mainWindow;
-        private String theme;
-
-        private Map<String, UI.LegacyWindow> legacyUINames = new HashMap<String, UI.LegacyWindow>();
-
-        /**
-         * Sets the main window of this application. Setting window as a main
-         * window of this application also adds the window to this application.
-         * 
-         * @param mainWindow
-         *            the UI to set as the default window
-         */
-        public void setMainWindow(UI.LegacyWindow mainWindow) {
-            if (this.mainWindow != null) {
-                throw new IllegalStateException(
-                        "mainWindow has already been set");
-            }
-            if (mainWindow.getApplication() == null) {
-                mainWindow.setApplication(Application.getCurrent());
-            } else if (mainWindow.getApplication() != Application.getCurrent()) {
-                throw new IllegalStateException(
-                        "mainWindow is attached to another application");
-            }
-            if (UI.getCurrent() == null) {
-                // Assume setting a main window from Application.init if there's
-                // no current UI -> set the main window as the current UI
-                UI.setCurrent(mainWindow);
-            }
-            this.mainWindow = mainWindow;
-        }
-
-        public void doInit() {
-            Application.getCurrent().setErrorHandler(this);
-            init();
-        }
-
-        protected abstract void init();
-
-        @Override
-        public Class<? extends UI> getUIClass(Application application,
-                WrappedRequest request) {
-            UI uiInstance = getUIInstance(request);
-            if (uiInstance != null) {
-                return uiInstance.getClass();
-            }
-            return null;
-        }
-
-        @Override
-        public UI createInstance(Application application,
-                Class<? extends UI> type, WrappedRequest request) {
-            return getUIInstance(request);
-        }
-
-        @Override
-        public String getThemeForUI(WrappedRequest request,
-                Class<? extends UI> uiClass) {
-            return theme;
-        }
-
-        @Override
-        public String getPageTitleForUI(WrappedRequest request,
-                Class<? extends UI> uiClass) {
-            UI uiInstance = getUIInstance(request);
-            if (uiInstance != null) {
-                return uiInstance.getCaption();
-            } else {
-                return super.getPageTitleForUI(request, uiClass);
-            }
-        }
-
-        /**
-         * Gets the mainWindow of the application.
-         * 
-         * <p>
-         * The main window is the window attached to the application URL (
-         * {@link #getURL()}) and thus which is show by default to the user.
-         * </p>
-         * <p>
-         * Note that each application must have at least one main window.
-         * </p>
-         * 
-         * @return the UI used as the default window
-         */
-        public UI.LegacyWindow getMainWindow() {
-            return mainWindow;
-        }
-
-        private UI getUIInstance(WrappedRequest request) {
-            String pathInfo = request.getRequestPathInfo();
-            String name = null;
-            if (pathInfo != null && pathInfo.length() > 0) {
-                Matcher matcher = WINDOW_NAME_PATTERN.matcher(pathInfo);
-                if (matcher.matches()) {
-                    // Skip the initial slash
-                    name = matcher.group(1);
-                }
-            }
-            UI.LegacyWindow window = getWindow(name);
-            if (window != null) {
-                return window;
-            }
-            return mainWindow;
-        }
-
-        /**
-         * This implementation simulates the way of finding a window for a
-         * request by extracting a window name from the requested path and
-         * passes that name to {@link #getWindow(String)}.
-         * <p>
-         * {@inheritDoc}
-         */
-        @Override
-        public UI getExistingUI(WrappedRequest request) {
-            UI uiInstance = getUIInstance(request);
-            if (uiInstance.getUIId() == -1) {
-                // Not initialized -> Let go through createUIInstance to make it
-                // initialized
-                return null;
-            } else {
-                UI.setCurrent(uiInstance);
-                return uiInstance;
-            }
-        }
-
-        /**
-         * Sets the application's theme.
-         * <p>
-         * Note that this theme can be overridden for a specific UI with
-         * {@link Application#getThemeForUI(UI)}. Setting theme to be
-         * <code>null</code> selects the default theme. For the available theme
-         * names, see the contents of the VAADIN/themes directory.
-         * </p>
-         * 
-         * @param theme
-         *            the new theme for this application.
-         */
-        public void setTheme(String theme) {
-            this.theme = theme;
-        }
-
-        /**
-         * Gets the application's theme. The application's theme is the default
-         * theme used by all the uIs for which a theme is not explicitly
-         * defined. If the application theme is not explicitly set,
-         * <code>null</code> is returned.
-         * 
-         * @return the name of the application's theme.
-         */
-        public String getTheme() {
-            return theme;
-        }
-
-        /**
-         * <p>
-         * Gets a UI by name. Returns <code>null</code> if the application is
-         * not running or it does not contain a window corresponding to the
-         * name.
-         * </p>
-         * 
-         * @param name
-         *            the name of the requested window
-         * @return a UI corresponding to the name, or <code>null</code> to use
-         *         the default window
-         */
-        public UI.LegacyWindow getWindow(String name) {
-            return legacyUINames.get(name);
-        }
-
-        /**
-         * Counter to get unique names for windows with no explicit name
-         */
-        private int namelessUIIndex = 0;
-
-        /**
-         * Adds a new browser level window to this application. Please note that
-         * UI doesn't have a name that is used in the URL - to add a named
-         * window you should instead use {@link #addWindow(UI, String)}
-         * 
-         * @param uI
-         *            the UI window to add to the application
-         * @return returns the name that has been assigned to the window
-         * 
-         * @see #addWindow(UI, String)
-         */
-        public void addWindow(UI.LegacyWindow uI) {
-            if (uI.getName() == null) {
-                String name = Integer.toString(namelessUIIndex++);
-                uI.setName(name);
-            }
-
-            legacyUINames.put(uI.getName(), uI);
-            uI.setApplication(Application.getCurrent());
-        }
-
-        /**
-         * Removes the specified window from the application. This also removes
-         * all name mappings for the window (see {@link #addWindow(UI, String)
-         * and #getWindowName(UI)}.
-         * 
-         * <p>
-         * Note that removing window from the application does not close the
-         * browser window - the window is only removed from the server-side.
-         * </p>
-         * 
-         * @param uI
-         *            the UI to remove
-         */
-        public void removeWindow(UI.LegacyWindow uI) {
-            for (Entry<String, UI.LegacyWindow> entry : legacyUINames
-                    .entrySet()) {
-                if (entry.getValue() == uI) {
-                    legacyUINames.remove(entry.getKey());
-                }
-            }
-        }
-
-        /**
-         * Gets the set of windows contained by the application.
-         * 
-         * <p>
-         * Note that the returned set of windows can not be modified.
-         * </p>
-         * 
-         * @return the unmodifiable collection of windows.
-         */
-        public Collection<UI.LegacyWindow> getWindows() {
-            return Collections.unmodifiableCollection(legacyUINames.values());
-        }
-
-        @Override
-        public void terminalError(ErrorEvent event) {
-            Application.getCurrent().terminalError(event);
-        }
-
-        public ApplicationContext getContext() {
-            return Application.getCurrent().getContext();
-        }
-
-        protected void close() {
-            Application.getCurrent().close();
-        }
-
-        public boolean isRunning() {
-            return Application.getCurrent().isRunning();
-        }
-
-        public URL getURL() {
-            return Application.getCurrent().getURL();
-        }
-    }
-
-    /**
      * An event sent to {@link #start(ApplicationStartEvent)} when a new
      * Application is being started.
      * 
diff --git a/server/src/com/vaadin/LegacyApplication.java b/server/src/com/vaadin/LegacyApplication.java
new file mode 100644
index 0000000000..5bfc466fa4
--- /dev/null
+++ b/server/src/com/vaadin/LegacyApplication.java
@@ -0,0 +1,306 @@
+/*
+ * Copyright 2011 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;
+
+import java.net.URL;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import com.vaadin.server.AbstractUIProvider;
+import com.vaadin.server.ApplicationContext;
+import com.vaadin.server.WrappedRequest;
+import com.vaadin.server.Terminal.ErrorEvent;
+import com.vaadin.server.Terminal.ErrorListener;
+import com.vaadin.ui.UI;
+import com.vaadin.ui.UI.LegacyWindow;
+
+/**
+ * A special application designed to help migrating applications from Vaadin
+ * 6 to Vaadin 7. The legacy application supports setting a main window,
+ * adding additional browser level windows and defining the theme for the
+ * entire application.
+ * 
+ * @deprecated This class is only intended to ease migration and should not
+ *             be used for new projects.
+ * 
+ * @since 7.0
+ */
+@Deprecated
+public abstract class LegacyApplication extends AbstractUIProvider
+        implements ErrorListener {
+    /**
+     * Ignore initial / and then get everything up to the next /
+     */
+    private static final Pattern WINDOW_NAME_PATTERN = Pattern
+            .compile("^/?([^/]+).*");
+
+    private UI.LegacyWindow mainWindow;
+    private String theme;
+
+    private Map<String, UI.LegacyWindow> legacyUINames = new HashMap<String, UI.LegacyWindow>();
+
+    /**
+     * Sets the main window of this application. Setting window as a main
+     * window of this application also adds the window to this application.
+     * 
+     * @param mainWindow
+     *            the UI to set as the default window
+     */
+    public void setMainWindow(UI.LegacyWindow mainWindow) {
+        if (this.mainWindow != null) {
+            throw new IllegalStateException(
+                    "mainWindow has already been set");
+        }
+        if (mainWindow.getApplication() == null) {
+            mainWindow.setApplication(Application.getCurrent());
+        } else if (mainWindow.getApplication() != Application.getCurrent()) {
+            throw new IllegalStateException(
+                    "mainWindow is attached to another application");
+        }
+        if (UI.getCurrent() == null) {
+            // Assume setting a main window from Application.init if there's
+            // no current UI -> set the main window as the current UI
+            UI.setCurrent(mainWindow);
+        }
+        this.mainWindow = mainWindow;
+    }
+
+    public void doInit() {
+        Application.getCurrent().setErrorHandler(this);
+        init();
+    }
+
+    protected abstract void init();
+
+    @Override
+    public Class<? extends UI> getUIClass(Application application,
+            WrappedRequest request) {
+        UI uiInstance = getUIInstance(request);
+        if (uiInstance != null) {
+            return uiInstance.getClass();
+        }
+        return null;
+    }
+
+    @Override
+    public UI createInstance(Application application,
+            Class<? extends UI> type, WrappedRequest request) {
+        return getUIInstance(request);
+    }
+
+    @Override
+    public String getThemeForUI(WrappedRequest request,
+            Class<? extends UI> uiClass) {
+        return theme;
+    }
+
+    @Override
+    public String getPageTitleForUI(WrappedRequest request,
+            Class<? extends UI> uiClass) {
+        UI uiInstance = getUIInstance(request);
+        if (uiInstance != null) {
+            return uiInstance.getCaption();
+        } else {
+            return super.getPageTitleForUI(request, uiClass);
+        }
+    }
+
+    /**
+     * Gets the mainWindow of the application.
+     * 
+     * <p>
+     * The main window is the window attached to the application URL (
+     * {@link #getURL()}) and thus which is show by default to the user.
+     * </p>
+     * <p>
+     * Note that each application must have at least one main window.
+     * </p>
+     * 
+     * @return the UI used as the default window
+     */
+    public UI.LegacyWindow getMainWindow() {
+        return mainWindow;
+    }
+
+    private UI getUIInstance(WrappedRequest request) {
+        String pathInfo = request.getRequestPathInfo();
+        String name = null;
+        if (pathInfo != null && pathInfo.length() > 0) {
+            Matcher matcher = WINDOW_NAME_PATTERN.matcher(pathInfo);
+            if (matcher.matches()) {
+                // Skip the initial slash
+                name = matcher.group(1);
+            }
+        }
+        UI.LegacyWindow window = getWindow(name);
+        if (window != null) {
+            return window;
+        }
+        return mainWindow;
+    }
+
+    /**
+     * This implementation simulates the way of finding a window for a
+     * request by extracting a window name from the requested path and
+     * passes that name to {@link #getWindow(String)}.
+     * <p>
+     * {@inheritDoc}
+     */
+    @Override
+    public UI getExistingUI(WrappedRequest request) {
+        UI uiInstance = getUIInstance(request);
+        if (uiInstance.getUIId() == -1) {
+            // Not initialized -> Let go through createUIInstance to make it
+            // initialized
+            return null;
+        } else {
+            UI.setCurrent(uiInstance);
+            return uiInstance;
+        }
+    }
+
+    /**
+     * Sets the application's theme.
+     * <p>
+     * Note that this theme can be overridden for a specific UI with
+     * {@link Application#getThemeForUI(UI)}. Setting theme to be
+     * <code>null</code> selects the default theme. For the available theme
+     * names, see the contents of the VAADIN/themes directory.
+     * </p>
+     * 
+     * @param theme
+     *            the new theme for this application.
+     */
+    public void setTheme(String theme) {
+        this.theme = theme;
+    }
+
+    /**
+     * Gets the application's theme. The application's theme is the default
+     * theme used by all the uIs for which a theme is not explicitly
+     * defined. If the application theme is not explicitly set,
+     * <code>null</code> is returned.
+     * 
+     * @return the name of the application's theme.
+     */
+    public String getTheme() {
+        return theme;
+    }
+
+    /**
+     * <p>
+     * Gets a UI by name. Returns <code>null</code> if the application is
+     * not running or it does not contain a window corresponding to the
+     * name.
+     * </p>
+     * 
+     * @param name
+     *            the name of the requested window
+     * @return a UI corresponding to the name, or <code>null</code> to use
+     *         the default window
+     */
+    public UI.LegacyWindow getWindow(String name) {
+        return legacyUINames.get(name);
+    }
+
+    /**
+     * Counter to get unique names for windows with no explicit name
+     */
+    private int namelessUIIndex = 0;
+
+    /**
+     * Adds a new browser level window to this application. Please note that
+     * UI doesn't have a name that is used in the URL - to add a named
+     * window you should instead use {@link #addWindow(UI, String)}
+     * 
+     * @param uI
+     *            the UI window to add to the application
+     * @return returns the name that has been assigned to the window
+     * 
+     * @see #addWindow(UI, String)
+     */
+    public void addWindow(UI.LegacyWindow uI) {
+        if (uI.getName() == null) {
+            String name = Integer.toString(namelessUIIndex++);
+            uI.setName(name);
+        }
+
+        legacyUINames.put(uI.getName(), uI);
+        uI.setApplication(Application.getCurrent());
+    }
+
+    /**
+     * Removes the specified window from the application. This also removes
+     * all name mappings for the window (see {@link #addWindow(UI, String)
+     * and #getWindowName(UI)}.
+     * 
+     * <p>
+     * Note that removing window from the application does not close the
+     * browser window - the window is only removed from the server-side.
+     * </p>
+     * 
+     * @param uI
+     *            the UI to remove
+     */
+    public void removeWindow(UI.LegacyWindow uI) {
+        for (Entry<String, UI.LegacyWindow> entry : legacyUINames
+                .entrySet()) {
+            if (entry.getValue() == uI) {
+                legacyUINames.remove(entry.getKey());
+            }
+        }
+    }
+
+    /**
+     * Gets the set of windows contained by the application.
+     * 
+     * <p>
+     * Note that the returned set of windows can not be modified.
+     * </p>
+     * 
+     * @return the unmodifiable collection of windows.
+     */
+    public Collection<UI.LegacyWindow> getWindows() {
+        return Collections.unmodifiableCollection(legacyUINames.values());
+    }
+
+    @Override
+    public void terminalError(ErrorEvent event) {
+        Application.getCurrent().terminalError(event);
+    }
+
+    public ApplicationContext getContext() {
+        return Application.getCurrent().getContext();
+    }
+
+    protected void close() {
+        Application.getCurrent().close();
+    }
+
+    public boolean isRunning() {
+        return Application.getCurrent().isRunning();
+    }
+
+    public URL getURL() {
+        return Application.getCurrent().getURL();
+    }
+}
\ No newline at end of file
diff --git a/server/src/com/vaadin/server/LegacyVaadinPortlet.java b/server/src/com/vaadin/server/LegacyVaadinPortlet.java
index 036242a0c2..7de38eaf94 100644
--- a/server/src/com/vaadin/server/LegacyVaadinPortlet.java
+++ b/server/src/com/vaadin/server/LegacyVaadinPortlet.java
@@ -20,7 +20,7 @@ import javax.portlet.PortletException;
 import javax.portlet.PortletRequest;
 
 import com.vaadin.Application;
-import com.vaadin.Application.LegacyApplication;
+import com.vaadin.LegacyApplication;
 import com.vaadin.server.ServletPortletHelper.ApplicationClassException;
 
 public class LegacyVaadinPortlet extends VaadinPortlet {
diff --git a/server/src/com/vaadin/server/LegacyVaadinServlet.java b/server/src/com/vaadin/server/LegacyVaadinServlet.java
index f53e9d4bf0..21419a2e33 100644
--- a/server/src/com/vaadin/server/LegacyVaadinServlet.java
+++ b/server/src/com/vaadin/server/LegacyVaadinServlet.java
@@ -20,7 +20,7 @@ import javax.servlet.ServletException;
 import javax.servlet.http.HttpServletRequest;
 
 import com.vaadin.Application;
-import com.vaadin.Application.LegacyApplication;
+import com.vaadin.LegacyApplication;
 import com.vaadin.server.ServletPortletHelper.ApplicationClassException;
 
 public class LegacyVaadinServlet extends VaadinServlet {
diff --git a/server/src/com/vaadin/server/ServletPortletHelper.java b/server/src/com/vaadin/server/ServletPortletHelper.java
index 18fbb66114..28a63fe35b 100644
--- a/server/src/com/vaadin/server/ServletPortletHelper.java
+++ b/server/src/com/vaadin/server/ServletPortletHelper.java
@@ -4,7 +4,7 @@ import java.io.Serializable;
 import java.util.Properties;
 
 import com.vaadin.Application;
-import com.vaadin.Application.LegacyApplication;
+import com.vaadin.LegacyApplication;
 import com.vaadin.shared.ApplicationConstants;
 import com.vaadin.ui.UI;
 
diff --git a/server/src/com/vaadin/ui/UI.java b/server/src/com/vaadin/ui/UI.java
index e016e9432c..7389a898eb 100644
--- a/server/src/com/vaadin/ui/UI.java
+++ b/server/src/com/vaadin/ui/UI.java
@@ -28,6 +28,7 @@ import java.util.LinkedHashSet;
 import java.util.Map;
 
 import com.vaadin.Application;
+import com.vaadin.LegacyApplication;
 import com.vaadin.event.Action;
 import com.vaadin.event.Action.Handler;
 import com.vaadin.event.ActionManager;
@@ -89,7 +90,7 @@ public abstract class UI extends AbstractComponentContainer implements
     /**
      * Helper class to emulate the main window from Vaadin 6 using UIs. This
      * class should be used in the same way as Window used as a browser level
-     * window in Vaadin 6 with {@link com.vaadin.Application.LegacyApplication}
+     * window in Vaadin 6 with {@link com.vaadin.LegacyApplication}
      */
     @Deprecated
     public static class LegacyWindow extends UI {