taverna-server-webapp/src/main/java/org/taverna/server/master/common/VersionedElement.java

/*
 */
package org.taverna.server.master.common;
/*
 * 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.
 */

import static org.apache.commons.logging.LogFactory.getLog;
import static org.taverna.server.master.common.Namespaces.SERVER;

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlType;

import org.apache.commons.logging.Log;

/**
 * The type of an element that declares the version of the server that produced
 * it.
 * 
 * @author Donal Fellows
 */
@XmlType(name = "VersionedElement", namespace = SERVER)
public abstract class VersionedElement {
	/** What version of server produced this element? */
	@XmlAttribute(namespace = SERVER)
	public String serverVersion;
	/** What revision of server produced this element? Derived from SCM commit. */
	@XmlAttribute(namespace = SERVER)
	public String serverRevision;
	/** When was the server built? */
	@XmlAttribute(namespace = SERVER)
	public String serverBuildTimestamp;
	public static final String VERSION, REVISION, TIMESTAMP;
	static {
		Log log = getLog("Taverna.Server.Webapp");
		Properties p = new Properties();
		try {
			try (InputStream is = VersionedElement.class
					.getResourceAsStream("/version.properties")) {
				p.load(is);
			}
		} catch (IOException e) {
			log.warn("failed to read /version.properties", e);
		}
		VERSION = p.getProperty("tavernaserver.version", "unknownVersion");
		REVISION = String.format("%s (tag: %s)",
				p.getProperty("tavernaserver.branch", "unknownRevision"),
				p.getProperty("tavernaserver.revision.describe", "unknownTag"));
		TIMESTAMP = p
				.getProperty("tavernaserver.timestamp", "unknownTimestamp");
	}

	public VersionedElement() {
	}

	protected VersionedElement(boolean ignored) {
		serverVersion = VERSION;
		serverRevision = REVISION;
		serverBuildTimestamp = TIMESTAMP;
	}
}