svn commit: r1053650 - in /wicket/trunk: wicket-core/src/main/java/org/apache/wicket/ajax/ wicket-core/src/main/java/org/apache/wicket/protocol/http/ wicket-core/src/test/java/org/apache/wicket/ajax/ wicket-util/src/main/java/org/apache/wicket/util/lis...

[mg...@apache.org]

Author: mgrigorov
Date: Wed Dec 29 15:19:45 2010
New Revision: 1053650

URL: http://svn.apache.org/viewvc?rev=1053650&view=rev
Log:
WICKET-3263 Allow AjaxRequestTarget.IListeners to be Registered at the WebApplication Level

Make WebApplication#newAjaxRequestTarget() final and introduce IProvider for it and listeners (AjaxRequestTarget.IListener)

Added:
    wicket/trunk/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxRequestTargetListenerCollection.java   (with props)
Modified:
    wicket/trunk/wicket-core/src/main/java/org/apache/wicket/protocol/http/WebApplication.java
    wicket/trunk/wicket-core/src/test/java/org/apache/wicket/ajax/AjaxRequestTargetTest.java
    wicket/trunk/wicket-util/src/main/java/org/apache/wicket/util/listener/ListenerCollection.java

Added: wicket/trunk/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxRequestTargetListenerCollection.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxRequestTargetListenerCollection.java?rev=1053650&view=auto
==============================================================================
--- wicket/trunk/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxRequestTargetListenerCollection.java (added)
+++ wicket/trunk/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxRequestTargetListenerCollection.java Wed Dec 29 15:19:45 2010
@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.wicket.ajax;
+
+import org.apache.wicket.util.listener.ListenerCollection;
+
+/**
+ * A collection of {@link AjaxRequestTarget.IListener}s
+ * 
+ * @since 1.5
+ */
+public class AjaxRequestTargetListenerCollection extends
+	ListenerCollection<AjaxRequestTarget.IListener>
+{
+	private static final long serialVersionUID = 1L;
+}
\ No newline at end of file

Propchange: wicket/trunk/wicket-core/src/main/java/org/apache/wicket/ajax/AjaxRequestTargetListenerCollection.java
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: wicket/trunk/wicket-core/src/main/java/org/apache/wicket/protocol/http/WebApplication.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket-core/src/main/java/org/apache/wicket/protocol/http/WebApplication.java?rev=1053650&r1=1053649&r2=1053650&view=diff
==============================================================================
--- wicket/trunk/wicket-core/src/main/java/org/apache/wicket/protocol/http/WebApplication.java (original)
+++ wicket/trunk/wicket-core/src/main/java/org/apache/wicket/protocol/http/WebApplication.java Wed Dec 29 15:19:45 2010
@@ -28,6 +28,7 @@ import org.apache.wicket.RuntimeConfigur
 import org.apache.wicket.Session;
 import org.apache.wicket.WicketRuntimeException;
 import org.apache.wicket.ajax.AjaxRequestTarget;
+import org.apache.wicket.ajax.AjaxRequestTargetListenerCollection;
 import org.apache.wicket.markup.html.pages.AccessDeniedPage;
 import org.apache.wicket.markup.html.pages.InternalErrorPage;
 import org.apache.wicket.markup.html.pages.PageExpiredErrorPage;
@@ -49,6 +50,7 @@ import org.apache.wicket.request.mapper.
 import org.apache.wicket.request.resource.ResourceReference;
 import org.apache.wicket.session.HttpSessionStore;
 import org.apache.wicket.session.ISessionStore;
+import org.apache.wicket.util.IContextProvider;
 import org.apache.wicket.util.IProvider;
 import org.apache.wicket.util.file.FileUploadCleaner;
 import org.apache.wicket.util.file.IFileUploadCleaner;
@@ -109,6 +111,10 @@ public abstract class WebApplication ext
 
 	private ServletContext servletContext;
 
+	private final AjaxRequestTargetListenerCollection ajaxRequestTargetListeners;
+
+	private IContextProvider<AjaxRequestTarget, Page> ajaxRequestTargetProvider;
+
 	/**
 	 * Covariant override for easy getting the current {@link WebApplication} without having to cast
 	 * it.
@@ -142,6 +148,7 @@ public abstract class WebApplication ext
 	 */
 	public WebApplication()
 	{
+		ajaxRequestTargetListeners = new AjaxRequestTargetListenerCollection();
 	}
 
 	/**
@@ -476,6 +483,7 @@ public abstract class WebApplication ext
 
 		setPageRendererProvider(new WebPageRendererProvider());
 		setSessionStoreProvider(new WebSessionStoreProvider());
+		setAjaxRequestTargetProvider(new DefaultAjaxRequestTargetProvider());
 		// Configure the app.
 		configure();
 	}
@@ -557,9 +565,14 @@ public abstract class WebApplication ext
 	 *            page on which ajax response is made
 	 * @return non-null ajax request target instance
 	 */
-	public AjaxRequestTarget newAjaxRequestTarget(final Page page)
+	public final AjaxRequestTarget newAjaxRequestTarget(final Page page)
 	{
-		return new AjaxRequestTarget(page);
+		AjaxRequestTarget target = getAjaxRequestTargetProvider().get(page);
+		for (AjaxRequestTarget.IListener listener : ajaxRequestTargetListeners)
+		{
+			target.addListener(listener);
+		}
+		return target;
 	}
 
 	/**
@@ -670,4 +683,46 @@ public abstract class WebApplication ext
 		}
 
 	}
+
+	/**
+	 * Returns the provider for {@link AjaxRequestTarget} objects.
+	 * 
+	 * @return the provider for {@link AjaxRequestTarget} objects.
+	 */
+	public IContextProvider<AjaxRequestTarget, Page> getAjaxRequestTargetProvider()
+	{
+		return ajaxRequestTargetProvider;
+	}
+
+	/**
+	 * Sets the provider for {@link AjaxRequestTarget} objects.
+	 * 
+	 * @param ajaxRequestTargetProvider
+	 *            the new provider
+	 */
+	public void setAjaxRequestTargetProvider(
+		IContextProvider<AjaxRequestTarget, Page> ajaxRequestTargetProvider)
+	{
+		this.ajaxRequestTargetProvider = ajaxRequestTargetProvider;
+	}
+
+	/**
+	 * Returns the registered {@link AjaxRequestTarget.IListener} objects.
+	 * 
+	 * @return the registered {@link AjaxRequestTarget.IListener} objects.
+	 */
+	public AjaxRequestTargetListenerCollection getAjaxRequestTargetListeners()
+	{
+		return ajaxRequestTargetListeners;
+	}
+
+	private static class DefaultAjaxRequestTargetProvider
+		implements
+			IContextProvider<AjaxRequestTarget, Page>
+	{
+		public AjaxRequestTarget get(Page context)
+		{
+			return new AjaxRequestTarget(context);
+		}
+	}
 }

Modified: wicket/trunk/wicket-core/src/test/java/org/apache/wicket/ajax/AjaxRequestTargetTest.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket-core/src/test/java/org/apache/wicket/ajax/AjaxRequestTargetTest.java?rev=1053650&r1=1053649&r2=1053650&view=diff
==============================================================================
--- wicket/trunk/wicket-core/src/test/java/org/apache/wicket/ajax/AjaxRequestTargetTest.java (original)
+++ wicket/trunk/wicket-core/src/test/java/org/apache/wicket/ajax/AjaxRequestTargetTest.java Wed Dec 29 15:19:45 2010
@@ -18,6 +18,7 @@ package org.apache.wicket.ajax;
 
 import java.io.IOException;
 import java.lang.reflect.Constructor;
+import java.util.Map;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
@@ -211,6 +212,40 @@ public class AjaxRequestTargetTest exten
 	}
 
 	/**
+	 * @see <a href="https://issues.apache.org/jira/browse/WICKET-3263">WICKET-3263</a>
+	 */
+	public void testGlobalAjaxRequestTargetListeners()
+	{
+		final ValidatingAjaxRequestTargetListener listener = new ValidatingAjaxRequestTargetListener();
+
+		tester.getApplication().getAjaxRequestTargetListeners().add(listener);
+
+		tester.startPage(TestEventPage.class);
+		tester.clickLink(MockPageWithLinkAndComponent.LINK_ID, true);
+
+		assertTrue(listener.onBeforeRespondExecuted);
+		assertTrue(listener.onAfterRespondExecuted);
+	}
+
+	private static class ValidatingAjaxRequestTargetListener implements AjaxRequestTarget.IListener
+	{
+		boolean onBeforeRespondExecuted = false;
+		boolean onAfterRespondExecuted = false;
+
+		public void onBeforeRespond(Map<String, Component> map, AjaxRequestTarget target)
+		{
+			onBeforeRespondExecuted = true;
+
+		}
+
+		public void onAfterRespond(Map<String, Component> map,
+			AjaxRequestTarget.IJavaScriptResponse response)
+		{
+			onAfterRespondExecuted = true;
+		}
+	}
+
+	/**
 	 */
 	public static class TestEventPage extends MockPageWithLinkAndComponent
 	{

Modified: wicket/trunk/wicket-util/src/main/java/org/apache/wicket/util/listener/ListenerCollection.java
URL: http://svn.apache.org/viewvc/wicket/trunk/wicket-util/src/main/java/org/apache/wicket/util/listener/ListenerCollection.java?rev=1053650&r1=1053649&r2=1053650&view=diff
==============================================================================
--- wicket/trunk/wicket-util/src/main/java/org/apache/wicket/util/listener/ListenerCollection.java (original)
+++ wicket/trunk/wicket-util/src/main/java/org/apache/wicket/util/listener/ListenerCollection.java Wed Dec 29 15:19:45 2010
@@ -17,6 +17,7 @@
 package org.apache.wicket.util.listener;
 
 import java.io.Serializable;
+import java.util.Iterator;
 import java.util.List;
 import java.util.concurrent.CopyOnWriteArrayList;
 
@@ -35,7 +36,7 @@ import org.slf4j.LoggerFactory;
  * @param <T>
  *            type of listeners
  */
-public abstract class ListenerCollection<T> implements Serializable
+public abstract class ListenerCollection<T> implements Serializable, Iterable<T>
 {
 	private static final long serialVersionUID = 1L;
 
@@ -143,4 +144,14 @@ public abstract class ListenerCollection
 		void notify(T listener);
 	}
 
+	/**
+	 * Returns an iterator that can iterate the listeners.
+	 * 
+	 * @return an iterator that can iterate the listeners.
+	 */
+	public Iterator<T> iterator()
+	{
+		return listeners.iterator();
+
+	}
 }