org.apache.wicket.atmosphere.AtmosphereBehavior 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 org.apache.wicket.Application;
import org.apache.wicket.Component;
import org.apache.wicket.MetaDataKey;
import org.apache.wicket.Page;
import org.apache.wicket.WicketRuntimeException;
import org.apache.wicket.ajax.json.JSONException;
import org.apache.wicket.ajax.json.JSONObject;
import org.apache.wicket.behavior.AbstractAjaxBehavior;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.JavaScriptHeaderItem;
import org.apache.wicket.markup.head.OnDomReadyHeaderItem;
import org.apache.wicket.protocol.http.servlet.ServletWebRequest;
import org.apache.wicket.request.Url;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.http.WebRequest;
import org.apache.wicket.resource.CoreLibrariesContributor;
import org.apache.wicket.util.string.Strings;
import org.atmosphere.cpr.AtmosphereRequest;
import org.atmosphere.cpr.AtmosphereResource;
import org.atmosphere.cpr.AtmosphereResourceEvent;
import org.atmosphere.cpr.AtmosphereResourceEventListener;
import org.atmosphere.cpr.HeaderConfig;
import org.atmosphere.cpr.Meteor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * {@code AtmosphereBehavior} manages the suspended connection from the client. It adds the required
 * javascript libraries to the markup which setup a suspended connection. This connection can be
 * websocket, streaming http or long-polling, depending on what the client and server support. This
 * behavior is added automatically to pages with components with event subscriptions.
 * 
 * @author papegaaij
 */
public class AtmosphereBehavior extends AbstractAjaxBehavior
	implements
		AtmosphereResourceEventListener
{
	private static final Logger log = LoggerFactory.getLogger(AtmosphereBehavior.class);

	/**
	 * The key under which a unique id is stored in the page. This id is unique for all clients.
	 */
	public static final MetaDataKey ATMOSPHERE_UUID = new MetaDataKey()
	{
		private static final long serialVersionUID = 1L;
	};

	private static final long serialVersionUID = 1L;

	private String applicationKey;


	/**
	 * Construct.
	 */
	public AtmosphereBehavior()
	{
		applicationKey = Application.get().getApplicationKey();
	}

	private EventBus findEventBus()
	{
		return EventBus.get(Application.get(applicationKey));
	}

	@Override
	public final boolean getStatelessHint(Component component)
	{
		return false;
	}

	@Override
	public void onPreSuspend(AtmosphereResourceEvent event)
	{
	}

	@Override
	public void onClose(AtmosphereResourceEvent event)
	{
	}


	@Override
	public void onRequest()
	{
		RequestCycle requestCycle = RequestCycle.get();
		ServletWebRequest request = (ServletWebRequest)requestCycle.getRequest();

		// Grab a Meteor
		Meteor meteor = Meteor.build(request.getContainerRequest());
		// Add us to the listener list.
		meteor.addListener(this);
		meteor.suspend(-1);

		String uuid = meteor.getAtmosphereResource().uuid();
		Page page = getComponent().getPage();
		page.setMetaData(ATMOSPHERE_UUID, uuid);
		findEventBus().registerPage(uuid, page);
	}

	@Override
	public void onBroadcast(AtmosphereResourceEvent event)
	{
		if (log.isDebugEnabled())
		{
			log.debug("onBroadcast: {}", event.getMessage());
		}

		// If we are using long-polling, resume the connection as soon as we get
		// an event.
		String transport = event.getResource()
			.getRequest()
			.getHeader(HeaderConfig.X_ATMOSPHERE_TRANSPORT);

		if (HeaderConfig.LONG_POLLING_TRANSPORT.equalsIgnoreCase(transport))
		{
			Meteor meteor = Meteor.lookup(event.getResource().getRequest());
			meteor.resume();
		}
		EventBus eventBus = findEventBus();
		if (eventBus.isWantAtmosphereNotifications())
		{
			eventBus.post(new AtmosphereInternalEvent(AtmosphereInternalEvent.Type.Broadcast, event));
		}
	}

	@Override
	public void onSuspend(AtmosphereResourceEvent event)
	{
		if (log.isDebugEnabled())
		{
			AtmosphereRequest atmosphereRequest = event.getResource().getRequest();
			String transport = atmosphereRequest.getHeader(HeaderConfig.X_ATMOSPHERE_TRANSPORT);
			log.debug(String.format("Suspending the %s response from ip %s:%s", transport == null
				? "websocket" : transport, atmosphereRequest.getRemoteAddr(), atmosphereRequest.getRemotePort()));
		}
	}

	@Override
	public void onResume(AtmosphereResourceEvent event)
	{
		if (log.isDebugEnabled())
		{
			AtmosphereRequest atmosphereRequest = event.getResource().getRequest();
			String transport = atmosphereRequest.getHeader(HeaderConfig.X_ATMOSPHERE_TRANSPORT);
			log.debug(String.format("Resuming the %s response from ip %s:%s", transport == null
				? "websocket" : transport, atmosphereRequest.getRemoteAddr(), atmosphereRequest.getRemotePort()));
		}
		EventBus eventBus = findEventBus();
		if (eventBus.isWantAtmosphereNotifications())
		{
			eventBus.post(new AtmosphereInternalEvent(AtmosphereInternalEvent.Type.Resume, event));
		}
	}

	@Override
	public void onDisconnect(AtmosphereResourceEvent event)
	{
		if (log.isDebugEnabled())
		{
			AtmosphereRequest atmosphereRequest = event.getResource().getRequest();
			String transport = atmosphereRequest.getHeader(HeaderConfig.X_ATMOSPHERE_TRANSPORT);
			log.debug(String.format("%s connection dropped from ip %s:%s", transport == null
				? "websocket" : transport, atmosphereRequest.getRemoteAddr(), atmosphereRequest.getRemotePort()));
		}
		// It is possible that the application has already been destroyed, in which case
		// unregistration is no longer needed
		EventBus eventBus = findEventBus();
		if (Application.get(applicationKey) != null)
		{
			eventBus.unregisterConnection(event.getResource().uuid());
		}

		if (eventBus.isWantAtmosphereNotifications())
		{
			eventBus.post(new AtmosphereInternalEvent(AtmosphereInternalEvent.Type.Disconnect, event));
		}
	}

	@Override
	public void onThrowable(AtmosphereResourceEvent event)
	{
		Throwable throwable = event.throwable();
		log.error(throwable.getMessage(), throwable);

		EventBus eventBus = findEventBus();
		if (eventBus.isWantAtmosphereNotifications())
		{
			eventBus.post(new AtmosphereInternalEvent(AtmosphereInternalEvent.Type.Throwable, event));
		}
	}
	
	@Override
	public void onHeartbeat(AtmosphereResourceEvent event)
	{
	}

	@Override
	public void renderHead(Component component, IHeaderResponse response)
	{
		super.renderHead(component, response);
		try
		{
			CoreLibrariesContributor.contributeAjax(component.getApplication(), response);

			response.render(JavaScriptHeaderItem.forReference(JQueryWicketAtmosphereResourceReference.get()));
			JSONObject options = findEventBus().getParameters().toJSON();
			options.put("url", getCallbackUrl());
			response.render(OnDomReadyHeaderItem.forScript("jQuery('#" + component.getMarkupId() +
					"').wicketAtmosphere(" + options.toString() + ")"));
		}
		catch (JSONException e)
		{
			throw new WicketRuntimeException(e);
		}
	}

	/**
	 * Make it look like a normal Ajax call so the page id/renderCount are not incremented when Atmosphere makes
	 * the "upgrade" request
	 *
	 * @return the url to this behavior's listener interface
	 */
	@Override
	public CharSequence getCallbackUrl()
	{
		RequestCycle requestCycle = getComponent().getRequestCycle();
		Url baseUrl = requestCycle.getUrlRenderer().getBaseUrl();
		CharSequence ajaxBaseUrl = Strings.escapeMarkup(baseUrl.toString());

		return new StringBuilder(256)
				.append(super.getCallbackUrl())
				.append('&').append(WebRequest.PARAM_AJAX).append("=true&")
				.append(WebRequest.PARAM_AJAX_BASE_URL).append('=').append(ajaxBaseUrl);
	}

	/**
	 * Find the Atmosphere UUID for the suspended connection for the given page (if any).
	 * 
	 * @param page
	 * @return The UUID of the Atmosphere Resource, or null if no resource is suspended for the
	 *         page.
	 */
	public static String getUUID(Page page)
	{
		return page.getMetaData(ATMOSPHERE_UUID);
	}

	/**
	 * @param resource
	 * @return the unique id for the given suspended connection
	 * @deprecated use {@link AtmosphereResource#uuid()}
	 */
	@Deprecated
	public static String getUUID(AtmosphereResource resource)
	{
		return resource.uuid();
	}
}