org.apache.wicket.atmosphere.AtmosphereEventSubscriptionCollector Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicket-atmosphere Show documentation
Wicket-Atmosphere provides integration of the Atmosphere Framework in Wicket.
There is a newer version: 0.41
/*
 * 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.atmosphere;

import java.lang.reflect.Method;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;

import org.apache.wicket.Component;
import org.apache.wicket.Page;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.application.IComponentOnBeforeRenderListener;
import org.apache.wicket.behavior.Behavior;

import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import com.google.common.collect.ImmutableList;

/**
 * Collects {@linkplain Subscribe event subscriptions} on components. Subscriptions are refreshed on
 * every render of component. If a page contains a component with a subscription, an
 * {@link AtmosphereBehavior} is added to the page. There is no need to register this listener, it
 * is added automatically by {@link EventBus}.
 * 
 * @author papegaaij
 */
public class AtmosphereEventSubscriptionCollector implements IComponentOnBeforeRenderListener
{
	private Cache, Iterable> subscribedMethodsCache;
	private EventBus eventBus;

	/**
	 * Construct.
	 * 
	 * @param eventBus
	 */
	public AtmosphereEventSubscriptionCollector(EventBus eventBus)
	{
		this.eventBus = eventBus;
		subscribedMethodsCache = CacheBuilder.newBuilder().build();
	}

	@Override
	public void onBeforeRender(Component component)
	{
		for (Method curMethod : findSubscribedMethods(component.getClass()))
		{
			subscribeComponent(component, null, curMethod);
		}
		for (Behavior curBehavior : component.getBehaviors())
		{
			for (Method curMethod : findSubscribedMethods(curBehavior.getClass()))
			{
				subscribeComponent(component, curBehavior, curMethod);
			}
		}
	}

	private Iterable findSubscribedMethods(final Class clazz)
	{
		try
		{
			return subscribedMethodsCache.get(clazz, new Callable>()
			{
				@Override
				public Iterable call() throws Exception
				{
					ImmutableList.Builder ret = ImmutableList.builder();
					for (Method curMethod : clazz.getMethods())
					{
						if (curMethod.isAnnotationPresent(Subscribe.class))
						{
							verifyMethodParameters(curMethod);
							ret.add(curMethod);
						}
					}
					return ret.build();
				}
			});
		}
		catch (ExecutionException e)
		{
			throw new WicketRuntimeException(e);
		}
	}

	private void verifyMethodParameters(Method method)
	{
		Class[] params = method.getParameterTypes();
		if (params.length != 2 || !params[0].equals(AjaxRequestTarget.class))
			throw new WicketRuntimeException("@Subscribe can only be used on " +
				"methods with 2 params, of which the first is AjaxRequestTarget. " + method +
				" does not conform to this signature.");
	}

	private void subscribeComponent(Component component, Behavior behavior, Method method)
	{
		EventSubscription subscription = new EventSubscription(component, behavior, method);
		Page page = component.getPage();
		eventBus.register(page, subscription);
		if (page.getBehaviors(AtmosphereBehavior.class).isEmpty())
			page.add(new AtmosphereBehavior());
	}
}