com.sitewhere.spi.server.ISiteWhereServerRuntime Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sitewhere-server-api Show documentation

SiteWhere Server API

There is a newer version: 1.11.0

/*
 * Copyright (c) SiteWhere, LLC. All rights reserved. http://www.sitewhere.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */
package com.sitewhere.spi.server;

import java.util.List;

/**
 * Holds runtime information about a SiteWhere server.
 * 
 * @author Derek
 */
public interface ISiteWhereServerRuntime {

	public IGeneralInformation getGeneral();

	public IJavaInformation getJava();

	/**
	 * General server information.
	 */
	public static interface IGeneralInformation {

		/**
		 * Get full edition name.
		 */
		public String getEdition();

		/**
		 * Get the short identifier for edition.
		 * 
		 * @return
		 */
		public String getEditionIdentifier();

		/**
		 * Gets the Maven version identifier.
		 * 
		 * @return
		 */
		public String getVersionIdentifier();

		/**
		 * Gets the build timestamp.
		 * 
		 * @return
		 */
		public String getBuildTimestamp();

		/**
		 * Get the amount of time in milliseconds the server has been up.
		 * 
		 * @return
		 */
		public Long getUptime();

		/**
		 * Get operating system name.
		 * 
		 * @return
		 */
		public String getOperatingSystemName();

		/**
		 * Get operating system version.
		 * 
		 * @return
		 */
		public String getOperatingSystemVersion();
	}

	/**
	 * Get information about Java VM.
	 */
	public static interface IJavaInformation {

		/**
		 * Get the JVM vendor.
		 * 
		 * @return
		 */
		public String getJvmVendor();

		/**
		 * Get the JVM version.
		 * 
		 * @return
		 */
		public String getJvmVersion();

		/**
		 * Get total memory allocated to JVM.
		 * 
		 * @return
		 */
		public Long getJvmTotalMemory();

		/**
		 * Get recent historical values for JVM total memory.
		 * 
		 * @return
		 */
		public List getJvmTotalMemoryHistory();

		/**
		 * Get free memory available to JVM.
		 * 
		 * @return
		 */
		public Long getJvmFreeMemory();

		/**
		 * Get recent historical values for JVM free memory.
		 * 
		 * @return
		 */
		public List getJvmFreeMemoryHistory();

		/**
		 * Get max memory available to JVM.
		 * 
		 * @return
		 */
		public Long getJvmMaxMemory();
	}
}