org.geomajas.service.impl.StaticDispatcherUrlService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geomajas-impl Show documentation

Geomajas server: Main - Implementation

The newest version!

/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2016 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */

package org.geomajas.service.impl;

import javax.validation.constraints.NotNull;

import org.geomajas.annotation.Api;
import org.geomajas.service.DispatcherUrlService;

/**
 * {@link DispatcherUrlService} which allows you to statically configure the URL for the dispatcher service.
 *
 * @author Joachim Van der Auwera
 * @author Jan De Moerloose
 * @since 1.8.0
 */
@Api(allMethods = true)
public class StaticDispatcherUrlService implements DispatcherUrlService {

	@NotNull
	private String dispatcherUrl;

	private String localDispatcherUrl;

	/**
	 * Set the URL for the dispatcher service. All controllers which are linked in using the dispatcher service have
	 * a URL starting with this string.
	 *
	 * @param dispatcherUrl dispatcher service URL
	 */
	public void setDispatcherUrl(String dispatcherUrl) {
		this.dispatcherUrl = dispatcherUrl;
	}

	@Override
	public String getDispatcherUrl() {
		return dispatcherUrl;
	}

	/**
	 * Set the local base URL for the dispatcher service.
	 * 
	 * @param localDispatcherUrl the local base URL
	 * @since 1.10.0
	 */
	public void setLocalDispatcherUrl(String localDispatcherUrl) {
		this.localDispatcherUrl = localDispatcherUrl;
	}

	/**
	 * @since 1.10.0
	 */
	public String getLocalDispatcherUrl() {
		return localDispatcherUrl;
	}

	/**
	 * @since 1.10.0
	 */
	public String localize(String externalUrl) {
		String localBase = getLocalDispatcherUrl();
		if (localBase == null) {
			return externalUrl;
		} else {
			String dispatcherBase = getDispatcherUrl();
			if (externalUrl.startsWith(dispatcherBase)) {
				return localBase + externalUrl.substring(dispatcherBase.length());
			} else {
				// not a dispatcher url, return the original one
				return externalUrl;
			}
		}
	}
}