From: Leif Åstrand Date: Mon, 13 Aug 2012 12:26:17 +0000 (+0300) Subject: Rename VaadinContext -> AddonContext (#9273) X-Git-Tag: 7.0.0.beta1~228^2~30 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=2e6313e12b7c11706d154befd0cdf3a665f46365;p=vaadin-framework.git Rename VaadinContext -> AddonContext (#9273) --- diff --git a/src/com/vaadin/terminal/DeploymentConfiguration.java b/src/com/vaadin/terminal/DeploymentConfiguration.java index 160350ca24..ae96dcaec5 100644 --- a/src/com/vaadin/terminal/DeploymentConfiguration.java +++ b/src/com/vaadin/terminal/DeploymentConfiguration.java @@ -11,8 +11,8 @@ import java.util.Properties; import javax.portlet.PortletContext; import javax.servlet.ServletContext; -import com.vaadin.terminal.gwt.server.VaadinContext; -import com.vaadin.terminal.gwt.server.VaadinContextListener; +import com.vaadin.terminal.gwt.server.AddonContext; +import com.vaadin.terminal.gwt.server.AddonContextListener; /** * Provide deployment specific settings that are required outside terminal @@ -115,9 +115,9 @@ public interface DeploymentConfiguration extends Serializable { */ public Properties getInitParameters(); - public Iterator getContextListeners(); + public Iterator getAddonContextListeners(); - public VaadinContext getVaadinContext(); + public AddonContext getAddonContext(); - public void setVaadinContext(VaadinContext vaadinContext); + public void setAddonContext(AddonContext vaadinContext); } diff --git a/src/com/vaadin/terminal/gwt/server/AbstractApplicationPortlet.java b/src/com/vaadin/terminal/gwt/server/AbstractApplicationPortlet.java index e5fb6afad2..40958e2868 100644 --- a/src/com/vaadin/terminal/gwt/server/AbstractApplicationPortlet.java +++ b/src/com/vaadin/terminal/gwt/server/AbstractApplicationPortlet.java @@ -290,7 +290,7 @@ public abstract class AbstractApplicationPortlet extends GenericPortlet } }; - private final VaadinContext vaadinContext = new VaadinContext( + private final AddonContext addonContext = new AddonContext( getDeploymentConfiguration()); @Override @@ -319,14 +319,14 @@ public abstract class AbstractApplicationPortlet extends GenericPortlet checkProductionMode(); checkCrossSiteProtection(); - vaadinContext.init(); + addonContext.init(); } @Override public void destroy() { super.destroy(); - vaadinContext.destroy(); + addonContext.destroy(); } private void checkCrossSiteProtection() { @@ -801,7 +801,7 @@ public abstract class AbstractApplicationPortlet extends GenericPortlet application.start(new ApplicationStartEvent(null, getDeploymentConfiguration().getInitParameters(), context, isProductionMode())); - vaadinContext.applicationStarted(application); + addonContext.applicationStarted(application); } } diff --git a/src/com/vaadin/terminal/gwt/server/AbstractApplicationServlet.java b/src/com/vaadin/terminal/gwt/server/AbstractApplicationServlet.java index b8aba5c4b4..603bc74a21 100644 --- a/src/com/vaadin/terminal/gwt/server/AbstractApplicationServlet.java +++ b/src/com/vaadin/terminal/gwt/server/AbstractApplicationServlet.java @@ -128,7 +128,7 @@ public abstract class AbstractApplicationServlet extends HttpServlet implements } }; - private final VaadinContext vaadinContext = new VaadinContext( + private final AddonContext addonContext = new AddonContext( getDeploymentConfiguration()); /** @@ -170,14 +170,14 @@ public abstract class AbstractApplicationServlet extends HttpServlet implements checkCrossSiteProtection(); checkResourceCacheTime(); - vaadinContext.init(); + addonContext.init(); } @Override public void destroy() { super.destroy(); - vaadinContext.destroy(); + addonContext.destroy(); } private void checkCrossSiteProtection() { @@ -901,7 +901,7 @@ public abstract class AbstractApplicationServlet extends HttpServlet implements application.start(new ApplicationStartEvent(applicationUrl, getDeploymentConfiguration().getInitParameters(), webApplicationContext, isProductionMode())); - vaadinContext.applicationStarted(application); + addonContext.applicationStarted(application); } } diff --git a/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java b/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java index 47bf5ecc60..f731cbbdd0 100644 --- a/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java +++ b/src/com/vaadin/terminal/gwt/server/AbstractDeploymentConfiguration.java @@ -16,7 +16,7 @@ public abstract class AbstractDeploymentConfiguration implements private final Class systemPropertyBaseClass; private final Properties applicationProperties = new Properties(); - private VaadinContext vaadinContext; + private AddonContext addonContext; public AbstractDeploymentConfiguration(Class systemPropertyBaseClass) { this.systemPropertyBaseClass = systemPropertyBaseClass; @@ -123,21 +123,21 @@ public abstract class AbstractDeploymentConfiguration implements } @Override - public Iterator getContextListeners() { + public Iterator getAddonContextListeners() { // Called once for init and once for destroy, so it's probably not worth // the effort caching the ServiceLoader instance - ServiceLoader contextListenerLoader = ServiceLoader - .load(VaadinContextListener.class, getClassLoader()); + ServiceLoader contextListenerLoader = ServiceLoader + .load(AddonContextListener.class, getClassLoader()); return contextListenerLoader.iterator(); } @Override - public void setVaadinContext(VaadinContext vaadinContext) { - this.vaadinContext = vaadinContext; + public void setAddonContext(AddonContext addonContext) { + this.addonContext = addonContext; } @Override - public VaadinContext getVaadinContext() { - return vaadinContext; + public AddonContext getAddonContext() { + return addonContext; } } diff --git a/src/com/vaadin/terminal/gwt/server/AddonContext.java b/src/com/vaadin/terminal/gwt/server/AddonContext.java new file mode 100644 index 0000000000..0f887b0fbd --- /dev/null +++ b/src/com/vaadin/terminal/gwt/server/AddonContext.java @@ -0,0 +1,80 @@ +/* +@VaadinApache2LicenseForJavaFiles@ + */ + +package com.vaadin.terminal.gwt.server; + +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.Iterator; +import java.util.List; + +import com.vaadin.Application; +import com.vaadin.event.EventRouter; +import com.vaadin.terminal.DeploymentConfiguration; +import com.vaadin.tools.ReflectTools; + +public class AddonContext { + private static final Method APPLICATION_STARTED_METHOD = ReflectTools + .findMethod(ApplicationStartedListener.class, "applicationStarted", + ApplicationStartedEvent.class); + + private final DeploymentConfiguration deploymentConfiguration; + + private final EventRouter eventRouter = new EventRouter(); + + private List bootstrapListeners = new ArrayList(); + + public AddonContext(DeploymentConfiguration deploymentConfiguration) { + this.deploymentConfiguration = deploymentConfiguration; + deploymentConfiguration.setAddonContext(this); + } + + public DeploymentConfiguration getDeploymentConfiguration() { + return deploymentConfiguration; + } + + public void init() { + AddonContextEvent event = new AddonContextEvent(this); + Iterator listeners = deploymentConfiguration + .getAddonContextListeners(); + while (listeners.hasNext()) { + AddonContextListener listener = listeners.next(); + listener.contextCreated(event); + } + } + + public void destroy() { + AddonContextEvent event = new AddonContextEvent(this); + Iterator listeners = deploymentConfiguration + .getAddonContextListeners(); + while (listeners.hasNext()) { + AddonContextListener listener = listeners.next(); + listener.contextDestoryed(event); + } + } + + public void addBootstrapListener(BootstrapListener listener) { + bootstrapListeners.add(listener); + } + + public void applicationStarted(Application application) { + eventRouter.fireEvent(new ApplicationStartedEvent(this, application)); + for (BootstrapListener l : bootstrapListeners) { + application.addBootstrapListener(l); + } + } + + public void addApplicationStartedListener( + ApplicationStartedListener applicationStartListener) { + eventRouter.addListener(ApplicationStartedEvent.class, + applicationStartListener, APPLICATION_STARTED_METHOD); + } + + public void removeApplicationStartedListener( + ApplicationStartedListener applicationStartListener) { + eventRouter.removeListener(ApplicationStartedEvent.class, + applicationStartListener, APPLICATION_STARTED_METHOD); + } + +} diff --git a/src/com/vaadin/terminal/gwt/server/AddonContextEvent.java b/src/com/vaadin/terminal/gwt/server/AddonContextEvent.java new file mode 100644 index 0000000000..33f681499f --- /dev/null +++ b/src/com/vaadin/terminal/gwt/server/AddonContextEvent.java @@ -0,0 +1,19 @@ +/* +@VaadinApache2LicenseForJavaFiles@ + */ + +package com.vaadin.terminal.gwt.server; + +import java.util.EventObject; + +public class AddonContextEvent extends EventObject { + + public AddonContextEvent(AddonContext source) { + super(source); + } + + public AddonContext getAddonContext() { + return (AddonContext) getSource(); + } + +} diff --git a/src/com/vaadin/terminal/gwt/server/AddonContextListener.java b/src/com/vaadin/terminal/gwt/server/AddonContextListener.java new file mode 100644 index 0000000000..93e7df4ede --- /dev/null +++ b/src/com/vaadin/terminal/gwt/server/AddonContextListener.java @@ -0,0 +1,13 @@ +/* +@VaadinApache2LicenseForJavaFiles@ + */ + +package com.vaadin.terminal.gwt.server; + +import java.util.EventListener; + +public interface AddonContextListener extends EventListener { + public void contextCreated(AddonContextEvent event); + + public void contextDestoryed(AddonContextEvent event); +} diff --git a/src/com/vaadin/terminal/gwt/server/ApplicationStartedEvent.java b/src/com/vaadin/terminal/gwt/server/ApplicationStartedEvent.java index 33859f5605..339b88222e 100644 --- a/src/com/vaadin/terminal/gwt/server/ApplicationStartedEvent.java +++ b/src/com/vaadin/terminal/gwt/server/ApplicationStartedEvent.java @@ -11,14 +11,14 @@ import com.vaadin.Application; public class ApplicationStartedEvent extends EventObject { private final Application application; - public ApplicationStartedEvent(VaadinContext context, + public ApplicationStartedEvent(AddonContext context, Application application) { super(context); this.application = application; } - public VaadinContext getContext() { - return (VaadinContext) getSource(); + public AddonContext getContext() { + return (AddonContext) getSource(); } public Application getApplication() { diff --git a/src/com/vaadin/terminal/gwt/server/VaadinContext.java b/src/com/vaadin/terminal/gwt/server/VaadinContext.java deleted file mode 100644 index 081f25bbfb..0000000000 --- a/src/com/vaadin/terminal/gwt/server/VaadinContext.java +++ /dev/null @@ -1,80 +0,0 @@ -/* -@VaadinApache2LicenseForJavaFiles@ - */ - -package com.vaadin.terminal.gwt.server; - -import java.lang.reflect.Method; -import java.util.ArrayList; -import java.util.Iterator; -import java.util.List; - -import com.vaadin.Application; -import com.vaadin.event.EventRouter; -import com.vaadin.terminal.DeploymentConfiguration; -import com.vaadin.tools.ReflectTools; - -public class VaadinContext { - private static final Method APPLICATION_STARTED_METHOD = ReflectTools - .findMethod(ApplicationStartedListener.class, "applicationStarted", - ApplicationStartedEvent.class); - - private final DeploymentConfiguration deploymentConfiguration; - - private final EventRouter eventRouter = new EventRouter(); - - private List bootstrapListeners = new ArrayList(); - - public VaadinContext(DeploymentConfiguration deploymentConfiguration) { - this.deploymentConfiguration = deploymentConfiguration; - deploymentConfiguration.setVaadinContext(this); - } - - public DeploymentConfiguration getDeploymentConfiguration() { - return deploymentConfiguration; - } - - public void init() { - VaadinContextEvent event = new VaadinContextEvent(this); - Iterator listeners = deploymentConfiguration - .getContextListeners(); - while (listeners.hasNext()) { - VaadinContextListener listener = listeners.next(); - listener.contextCreated(event); - } - } - - public void destroy() { - VaadinContextEvent event = new VaadinContextEvent(this); - Iterator listeners = deploymentConfiguration - .getContextListeners(); - while (listeners.hasNext()) { - VaadinContextListener listener = listeners.next(); - listener.contextDestoryed(event); - } - } - - public void addBootstrapListener(BootstrapListener listener) { - bootstrapListeners.add(listener); - } - - public void applicationStarted(Application application) { - eventRouter.fireEvent(new ApplicationStartedEvent(this, application)); - for (BootstrapListener l : bootstrapListeners) { - application.addBootstrapListener(l); - } - } - - public void addApplicationStartedListener( - ApplicationStartedListener applicationStartListener) { - eventRouter.addListener(ApplicationStartedEvent.class, - applicationStartListener, APPLICATION_STARTED_METHOD); - } - - public void removeApplicationStartedListener( - ApplicationStartedListener applicationStartListener) { - eventRouter.removeListener(ApplicationStartedEvent.class, - applicationStartListener, APPLICATION_STARTED_METHOD); - } - -} diff --git a/src/com/vaadin/terminal/gwt/server/VaadinContextEvent.java b/src/com/vaadin/terminal/gwt/server/VaadinContextEvent.java deleted file mode 100644 index 239490433c..0000000000 --- a/src/com/vaadin/terminal/gwt/server/VaadinContextEvent.java +++ /dev/null @@ -1,19 +0,0 @@ -/* -@VaadinApache2LicenseForJavaFiles@ - */ - -package com.vaadin.terminal.gwt.server; - -import java.util.EventObject; - -public class VaadinContextEvent extends EventObject { - - public VaadinContextEvent(VaadinContext source) { - super(source); - } - - public VaadinContext getVaadinContext() { - return (VaadinContext) getSource(); - } - -} diff --git a/src/com/vaadin/terminal/gwt/server/VaadinContextListener.java b/src/com/vaadin/terminal/gwt/server/VaadinContextListener.java deleted file mode 100644 index 5e379d9b91..0000000000 --- a/src/com/vaadin/terminal/gwt/server/VaadinContextListener.java +++ /dev/null @@ -1,13 +0,0 @@ -/* -@VaadinApache2LicenseForJavaFiles@ - */ - -package com.vaadin.terminal.gwt.server; - -import java.util.EventListener; - -public interface VaadinContextListener extends EventListener { - public void contextCreated(VaadinContextEvent event); - - public void contextDestoryed(VaadinContextEvent event); -} diff --git a/tests/testbench/META-INF/services/com.vaadin.terminal.gwt.server.AddonContextListener b/tests/testbench/META-INF/services/com.vaadin.terminal.gwt.server.AddonContextListener new file mode 100644 index 0000000000..9b3d9eb082 --- /dev/null +++ b/tests/testbench/META-INF/services/com.vaadin.terminal.gwt.server.AddonContextListener @@ -0,0 +1 @@ +com.vaadin.tests.vaadincontext.TestAddonContextListener \ No newline at end of file diff --git a/tests/testbench/META-INF/services/com.vaadin.terminal.gwt.server.VaadinContextListener b/tests/testbench/META-INF/services/com.vaadin.terminal.gwt.server.VaadinContextListener deleted file mode 100644 index fd5ebaa53e..0000000000 --- a/tests/testbench/META-INF/services/com.vaadin.terminal.gwt.server.VaadinContextListener +++ /dev/null @@ -1 +0,0 @@ -com.vaadin.tests.vaadincontext.TestVaadinContextListener \ No newline at end of file diff --git a/tests/testbench/com/vaadin/tests/vaadincontext/TestAddonContextListener.java b/tests/testbench/com/vaadin/tests/vaadincontext/TestAddonContextListener.java new file mode 100644 index 0000000000..08db5c72ec --- /dev/null +++ b/tests/testbench/com/vaadin/tests/vaadincontext/TestAddonContextListener.java @@ -0,0 +1,54 @@ +/* +@VaadinApache2LicenseForJavaFiles@ + */ + +package com.vaadin.tests.vaadincontext; + +import org.jsoup.nodes.Element; +import org.jsoup.parser.Tag; + +import com.vaadin.terminal.gwt.server.BootstrapFragmentResponse; +import com.vaadin.terminal.gwt.server.BootstrapListener; +import com.vaadin.terminal.gwt.server.BootstrapPageResponse; +import com.vaadin.terminal.gwt.server.BootstrapResponse; +import com.vaadin.terminal.gwt.server.AddonContextEvent; +import com.vaadin.terminal.gwt.server.AddonContextListener; +import com.vaadin.ui.Root; + +public class TestAddonContextListener implements AddonContextListener { + @Override + public void contextCreated(AddonContextEvent event) { + event.getAddonContext().addBootstrapListener(new BootstrapListener() { + @Override + public void modifyBootstrapFragment( + BootstrapFragmentResponse response) { + if (shouldModify(response)) { + Element heading = new Element(Tag.valueOf("div"), "") + .text("Added by modifyBootstrapFragment"); + response.getFragmentNodes().add(0, heading); + } + } + + private boolean shouldModify(BootstrapResponse response) { + Root root = response.getRoot(); + boolean shouldModify = root != null + && root.getClass() == BoostrapModifyRoot.class; + return shouldModify; + } + + @Override + public void modifyBootstrapPage(BootstrapPageResponse response) { + if (shouldModify(response)) { + response.getDocument().body().child(0) + .before("
Added by modifyBootstrapPage
"); + } + } + }); + } + + @Override + public void contextDestoryed(AddonContextEvent event) { + // Nothing to do + } + +} diff --git a/tests/testbench/com/vaadin/tests/vaadincontext/TestVaadinContextListener.java b/tests/testbench/com/vaadin/tests/vaadincontext/TestVaadinContextListener.java deleted file mode 100644 index 9d1fc6b6c3..0000000000 --- a/tests/testbench/com/vaadin/tests/vaadincontext/TestVaadinContextListener.java +++ /dev/null @@ -1,54 +0,0 @@ -/* -@VaadinApache2LicenseForJavaFiles@ - */ - -package com.vaadin.tests.vaadincontext; - -import org.jsoup.nodes.Element; -import org.jsoup.parser.Tag; - -import com.vaadin.terminal.gwt.server.BootstrapFragmentResponse; -import com.vaadin.terminal.gwt.server.BootstrapListener; -import com.vaadin.terminal.gwt.server.BootstrapPageResponse; -import com.vaadin.terminal.gwt.server.BootstrapResponse; -import com.vaadin.terminal.gwt.server.VaadinContextEvent; -import com.vaadin.terminal.gwt.server.VaadinContextListener; -import com.vaadin.ui.Root; - -public class TestVaadinContextListener implements VaadinContextListener { - @Override - public void contextCreated(VaadinContextEvent event) { - event.getVaadinContext().addBootstrapListener(new BootstrapListener() { - @Override - public void modifyBootstrapFragment( - BootstrapFragmentResponse response) { - if (shouldModify(response)) { - Element heading = new Element(Tag.valueOf("div"), "") - .text("Added by modifyBootstrapFragment"); - response.getFragmentNodes().add(0, heading); - } - } - - private boolean shouldModify(BootstrapResponse response) { - Root root = response.getRoot(); - boolean shouldModify = root != null - && root.getClass() == BoostrapModifyRoot.class; - return shouldModify; - } - - @Override - public void modifyBootstrapPage(BootstrapPageResponse response) { - if (shouldModify(response)) { - response.getDocument().body().child(0) - .before("
Added by modifyBootstrapPage
"); - } - } - }); - } - - @Override - public void contextDestoryed(VaadinContextEvent event) { - // Nothing to do - } - -}