TemplateLocations.java

/*
 * Copyright (c) 2013 Data Harmonisation Panel
 * 
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution. If not, see <http://www.gnu.org/licenses/>.
 * 
 * Contributors:
 *     Data Harmonisation Panel <http://www.dhpanel.eu>
 */

package eu.esdihumboldt.hale.server.templates.war;

import java.nio.file.Path;

import eu.esdihumboldt.hale.server.api.base.APIUtil;
import eu.esdihumboldt.hale.server.templates.TemplateScavenger;
import eu.esdihumboldt.hale.server.templates.war.resources.TemplatesResources;

/**
 * Helper methods to determine locations of specific resources.
 * 
 * @author Simon Templer
 */
public class TemplateLocations {

	/**
	 * Get the server base URL.
	 * 
	 * @return the base URL w/o trailing slash
	 */
	public static String getServerBaseUrl() {
		return System.getProperty(APIUtil.SYSTEM_PROPERTY_SERVER_URL, "http://localhost:8080");
	}

	private static String getContextPath() {
		return "/templates";
	}

	/**
	 * Get the URL to download a template archive.
	 * 
	 * @param templateId the template ID
	 * @return the URL to the archive
	 * @see TemplatesResources
	 */
	public static String getTemplateDownloadUrl(String templateId) {
		return getServerBaseUrl() + getContextPath() + "/resources/archive/" + templateId;
	}

	/**
	 * Get the URL to the project file of a template.
	 * 
	 * @param scavenger the template scavenger
	 * @param templateId the template ID
	 * @return the URL to the project file
	 * @see TemplatesResources
	 */
	public static String getTemplateProjectUrl(TemplateScavenger scavenger, String templateId) {
		Path base = scavenger.getHuntingGrounds().toPath();
		Path projectFilePath = scavenger.getReference(templateId).getProjectFile().toPath();
		String relativePath = base.relativize(projectFilePath).toString();
		return getServerBaseUrl() + getContextPath() + "/resources/files/" + relativePath;
	}

	/**
	 * Get the URL to a file of a template.
	 * 
	 * @param scavenger the template scavenger
	 * @param templateId the template ID
	 * @param templateRelativePath the relative path in the template to the file
	 * @return the URL to the project file
	 * @see TemplatesResources
	 */
	public static String getTemplateFileUrl(TemplateScavenger scavenger, String templateId,
			String templateRelativePath) {
		return getServerBaseUrl() + getContextPath() + "/resources/files/" + templateId + "/"
				+ templateRelativePath;
	}

	/**
	 * Get the URL to the web page for the template with the given identifier.
	 * 
	 * @param templateId the template identifier
	 * @return the template page URL
	 */
	public static String getTemplatePageUrl(String templateId) {
		return getServerBaseUrl() + getContextPath() + "/show/" + templateId;
	}
}