org.eclipse.kura.system

Interface SystemService

public interface SystemService

Service to provide basic system information including Operating System information, JVM information and filesystem information.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_CONSOLE_DEVICE_MANAGE_SERVICE_IGNORE
static String	KEY_BIOS_VERSION
static String	KEY_DEVICE_NAME
static String	KEY_FILE_SEP
static String	KEY_FIRMWARE_VERSION
static String	KEY_JAVA_HOME
static String	KEY_JAVA_VENDOR
static String	KEY_JAVA_VERSION
static String	KEY_JAVA_VM_INFO
static String	KEY_JAVA_VM_NAME
static String	KEY_JAVA_VM_VERSION
static String	KEY_KURA_DATA_DIR
static String	KEY_KURA_HAVE_NET_ADMIN
static String	KEY_KURA_HAVE_WEB_INTER
static String	KEY_KURA_HOME_DIR
static String	KEY_KURA_KEY_STORE_PWD
static String	KEY_KURA_NAME
static String	KEY_KURA_PLUGINS_DIR
static String	KEY_KURA_SNAPSHOTS_COUNT
static String	KEY_KURA_SNAPSHOTS_DIR
static String	KEY_KURA_STYLE_DIR
static String	KEY_KURA_TMP_DIR
static String	KEY_KURA_TRUST_STORE_PWD
static String	KEY_KURA_VERSION
static String	KEY_KURA_WIFI_TOP_CHANNEL
static String	KEY_MODEL_ID
static String	KEY_MODEL_NAME
static String	KEY_OS_ARCH
static String	KEY_OS_DISTRO
static String	KEY_OS_DISTRO_VER
static String	KEY_OS_NAME
static String	KEY_OS_VER
static String	KEY_OSGI_FW_NAME
static String	KEY_OSGI_FW_VERSION
static String	KEY_PART_NUMBER
static String	KEY_PLATFORM
static String	KEY_PRIMARY_NET_IFACE
static String	KEY_SERIAL_NUM
static String	KURA_CONFIG
static String	KURA_CUSTOM_CONFIG
static String	KURA_CUSTOM_PROPS_FILE
static String	KURA_PROPS_FILE
static String	OS_CLOUDBEES
static String	OS_LINUX
static String	OS_MAC_OSX
static String	UNKNOWN
static String	UNSUPPORTED

Method Summary

Methods

Modifier and Type	Method and Description
String	getBiosVersion() Gets the BIOS version of the device.
org.osgi.framework.Bundle[]	getBundles() Returns the OSGi bundles currently installed
List<String>	getDeviceManagementServiceIgnore() Returns a list of services that should be ignored by the Everyware Cloud Console
String	getDeviceName() Returns a friendly name assigned to this device.
String	getFileSeparator() Gets the system file separator used by the filesystem.
String	getFirmwareVersion() Gets the firmware version.
long	getFreeMemory() Returns the free memory for Java instance.
String	getJavaHome() Gets the location where the JVM is stored in the filesystem.
char[]	getJavaKeyStorePassword() Returns the password to access the private key from the keystore file.
char[]	getJavaTrustStorePassword() Returns the password to unlock the trust store keystore file.
String	getJavaVendor() Gets the vendor of the Java VM that is currently being used.
String	getJavaVersion() Gets the Java version that is currently being used.
String	getJavaVmInfo() Gets the Java Virtual Machine information that is currently being used.
String	getJavaVmName() Gets the Java Virtual Machine name that is currently being used.
String	getJavaVmVersion() Gets the Java Virtual Machine version that is currently being used.
String	getKuraDataDirectory() Gets the location where all Kura persistent data should be stored.
String	getKuraHome() Gets the location where the Kura root directory is stored in the filesystem.
int	getKuraSnapshotsCount() Returns the maximum number of snapshots to be retained in the file system.
String	getKuraSnapshotsDirectory() Gets the location where all Configuration Snapshots will be stored.
String	getKuraStyleDirectory() Gets the location where all custom style information is stored.
String	getKuraTemporaryConfigDirectory() Gets the location where all volatile Kura specific configuration and status information should be stored.
String	getKuraVersion() Gets the product version for this unit.
String	getKuraWebEnabled()
int	getKuraWifiTopChannel() Gets the last wifi channel allowed for this device.
String	getModelId() Gets the model identification of the device.
String	getModelName() Gets the model name of the device.
int	getNumberOfProcessors() Returns the number of processors visible to this Java platform.
String	getOsArch() Gets the Operating System architecture for the system.
String	getOsDistro() Gets the Operating System Distribution name if appropriate.
String	getOsDistroVersion() Gets the Operating System Distribution version if appropriate.
String	getOsgiFwName() Gets the name of the OSGI Framework that is currently being used.
String	getOsgiFwVersion() Gets the version of the OSGI Framework that is currently being used.
String	getOsName() Gets the Operating System name for the system.
String	getOsVersion() Gets the Operating System version for the system.
String	getPartNumber() Gets the part number.
String	getPlatform() Gets the platform name Kura is running on.
String	getPrimaryMacAddress() Gets the primary MAC address of the system
String	getPrimaryNetworkInterfaceName() Gets the name of the 'primary' network interface.
Properties	getProperties() Returns all KuraProperties for this system.
String	getSerialNumber() Gets the serial number of the device.
long	getTotalMemory() Returns the total memory visible to this Java instance.

Field Detail

KURA_CONFIG

static final String KURA_CONFIG

See Also:

Constant Field Values

KURA_PROPS_FILE

static final String KURA_PROPS_FILE

See Also:

Constant Field Values

KURA_CUSTOM_CONFIG

static final String KURA_CUSTOM_CONFIG

See Also:

Constant Field Values

KURA_CUSTOM_PROPS_FILE

static final String KURA_CUSTOM_PROPS_FILE

See Also:

Constant Field Values

OS_CLOUDBEES

static final String OS_CLOUDBEES

See Also:

Constant Field Values

OS_LINUX

static final String OS_LINUX

See Also:

Constant Field Values

OS_MAC_OSX

static final String OS_MAC_OSX

See Also:

Constant Field Values

UNKNOWN

static final String UNKNOWN

See Also:

Constant Field Values

UNSUPPORTED

static final String UNSUPPORTED

See Also:

Constant Field Values

KEY_KURA_NAME

static final String KEY_KURA_NAME

See Also:

Constant Field Values

KEY_KURA_VERSION

static final String KEY_KURA_VERSION

See Also:

Constant Field Values

KEY_DEVICE_NAME

static final String KEY_DEVICE_NAME

See Also:

Constant Field Values

KEY_PLATFORM

static final String KEY_PLATFORM

See Also:

Constant Field Values

KEY_MODEL_ID

static final String KEY_MODEL_ID

See Also:

Constant Field Values

KEY_MODEL_NAME

static final String KEY_MODEL_NAME

See Also:

Constant Field Values

KEY_PART_NUMBER

static final String KEY_PART_NUMBER

See Also:

Constant Field Values

KEY_SERIAL_NUM

static final String KEY_SERIAL_NUM

See Also:

Constant Field Values

KEY_BIOS_VERSION

static final String KEY_BIOS_VERSION

See Also:

Constant Field Values

KEY_FIRMWARE_VERSION

static final String KEY_FIRMWARE_VERSION

See Also:

Constant Field Values

KEY_PRIMARY_NET_IFACE

static final String KEY_PRIMARY_NET_IFACE

See Also:

Constant Field Values

KEY_KURA_HOME_DIR

static final String KEY_KURA_HOME_DIR

See Also:

Constant Field Values

KEY_KURA_PLUGINS_DIR

static final String KEY_KURA_PLUGINS_DIR

See Also:

Constant Field Values

KEY_KURA_DATA_DIR

static final String KEY_KURA_DATA_DIR

See Also:

Constant Field Values

KEY_KURA_TMP_DIR

static final String KEY_KURA_TMP_DIR

See Also:

Constant Field Values

KEY_KURA_SNAPSHOTS_DIR

static final String KEY_KURA_SNAPSHOTS_DIR

See Also:

Constant Field Values

KEY_KURA_SNAPSHOTS_COUNT

static final String KEY_KURA_SNAPSHOTS_COUNT

See Also:

Constant Field Values

KEY_KURA_HAVE_NET_ADMIN

static final String KEY_KURA_HAVE_NET_ADMIN

See Also:

Constant Field Values

KEY_KURA_HAVE_WEB_INTER

static final String KEY_KURA_HAVE_WEB_INTER

See Also:

Constant Field Values

KEY_KURA_STYLE_DIR

static final String KEY_KURA_STYLE_DIR

See Also:

Constant Field Values

KEY_KURA_WIFI_TOP_CHANNEL

static final String KEY_KURA_WIFI_TOP_CHANNEL

See Also:

Constant Field Values

KEY_KURA_KEY_STORE_PWD

static final String KEY_KURA_KEY_STORE_PWD

See Also:

Constant Field Values

KEY_KURA_TRUST_STORE_PWD

static final String KEY_KURA_TRUST_STORE_PWD

See Also:

Constant Field Values

KEY_OS_ARCH

static final String KEY_OS_ARCH

See Also:

Constant Field Values

KEY_OS_NAME

static final String KEY_OS_NAME

See Also:

Constant Field Values

KEY_OS_VER

static final String KEY_OS_VER

See Also:

Constant Field Values

KEY_OS_DISTRO

static final String KEY_OS_DISTRO

See Also:

Constant Field Values

KEY_OS_DISTRO_VER

static final String KEY_OS_DISTRO_VER

See Also:

Constant Field Values

KEY_JAVA_VERSION

static final String KEY_JAVA_VERSION

See Also:

Constant Field Values

KEY_JAVA_VENDOR

static final String KEY_JAVA_VENDOR

See Also:

Constant Field Values

KEY_JAVA_VM_NAME

static final String KEY_JAVA_VM_NAME

See Also:

Constant Field Values

KEY_JAVA_VM_VERSION

static final String KEY_JAVA_VM_VERSION

See Also:

Constant Field Values

KEY_JAVA_VM_INFO

static final String KEY_JAVA_VM_INFO

See Also:

Constant Field Values

KEY_OSGI_FW_NAME

static final String KEY_OSGI_FW_NAME

See Also:

Constant Field Values

KEY_OSGI_FW_VERSION

static final String KEY_OSGI_FW_VERSION

See Also:

Constant Field Values

KEY_JAVA_HOME

static final String KEY_JAVA_HOME

See Also:

Constant Field Values

KEY_FILE_SEP

static final String KEY_FILE_SEP

See Also:

Constant Field Values

CONFIG_CONSOLE_DEVICE_MANAGE_SERVICE_IGNORE

static final String CONFIG_CONSOLE_DEVICE_MANAGE_SERVICE_IGNORE

See Also:

Constant Field Values

Method Detail

getPrimaryMacAddress

String getPrimaryMacAddress()

Gets the primary MAC address of the system

Returns:

getPrimaryNetworkInterfaceName

String getPrimaryNetworkInterfaceName()

Gets the name of the 'primary' network interface.

Returns:

getPlatform

String getPlatform()

Gets the platform name Kura is running on. This could be catalyst, duracor1200, helios, isis, proteus, etc.

Returns:

The platform name.

getModelId

String getModelId()

Gets the model identification of the device.

Returns:

Model ID.

getModelName

String getModelName()

Gets the model name of the device.

Returns:

Model name.

getPartNumber

String getPartNumber()

Gets the part number.

Returns:

Part number.

getSerialNumber

String getSerialNumber()

Gets the serial number of the device.

Returns:

Serial number.

getDeviceName

String getDeviceName()

Returns a friendly name assigned to this device.

Returns:

getBiosVersion

String getBiosVersion()

Gets the BIOS version of the device.

Returns:

BIOS version.

getFirmwareVersion

String getFirmwareVersion()

Gets the firmware version.

Returns:

Firmware version.

getOsArch

String getOsArch()

Gets the Operating System architecture for the system.

Returns:

The Operating System architecture as defined by the Java System property os.arch.

getOsName

String getOsName()

Gets the Operating System name for the system.

Returns:

The Operating System name as defined by the Java System property os.name.

getOsVersion

String getOsVersion()

Gets the Operating System version for the system.

Returns:

The Operating System version as defined by the Java System property os.version.

getOsDistro

String getOsDistro()

Gets the Operating System Distribution name if appropriate.

Returns:

A String representing the Operating System Distribution name if appropriate.

getOsDistroVersion

String getOsDistroVersion()

Gets the Operating System Distribution version if appropriate.

Returns:

A String representing the Operating System Distribution version if appropriate.

getJavaVendor

String getJavaVendor()

Gets the vendor of the Java VM that is currently being used.

Returns:

The Java Runtime version as defined by the Java System property java.vendor.

getJavaVersion

String getJavaVersion()

Gets the Java version that is currently being used.

Returns:

The Java version as defined by the Java System property java.version.

getJavaVmName

String getJavaVmName()

Gets the Java Virtual Machine name that is currently being used.

Returns:

The Java Virtual Machine name as defined by the Java System property java.vm.name.

getJavaVmVersion

String getJavaVmVersion()

Gets the Java Virtual Machine version that is currently being used.

Returns:

The Java Virtual Machine version as defined by the Java System property java.vm.version.

getJavaVmInfo

String getJavaVmInfo()

Gets the Java Virtual Machine information that is currently being used.

Returns:

The Java Virtual Machine version as defined by the Java System property java.vm.version.

getOsgiFwName

String getOsgiFwName()

Gets the name of the OSGI Framework that is currently being used.

Returns:

The OSGI Framework Name as defined by the System property osgi.framework.name.

getOsgiFwVersion

String getOsgiFwVersion()

Gets the version of the OSGI Framework that is currently being used.

Returns:

The OSGI Framework Version as defined by the System property osgi.framework.version.

getFileSeparator

String getFileSeparator()

Gets the system file separator used by the filesystem.

Returns:

The system file separator used by the system.

getJavaHome

String getJavaHome()

Gets the location where the JVM is stored in the filesystem.

Returns:

The location of the root JVM directory.

getKuraVersion

String getKuraVersion()

Gets the product version for this unit. The product version is defined as the version in the release.xml file. The release.xml file is stored in /etc/kura/ and has the format: PRODUCT_NAME_release-VERSION-VERSION_NUMBER.xml For example this is a valid product name: helios_denali_release-1.2.3.xml. The version number would be 1.2.3. This would be an invalid product name: my-product-name_release-1.2.3.xml. This is because the product name has '-' characters in it. They should be '_' to be valid. So, the correct representation would be: my_product_name_release-1.2.3.xml. It's version number would be 1.2.3. The use of '-' characters should only be used immediately before the version number and the use of '.' characters should only be used immediately after the version number.

Returns:

The version number as denoted in the release.xml file.

getKuraHome

String getKuraHome()

Gets the location where the Kura root directory is stored in the filesystem.

Returns:

The root Kura directory.

getKuraTemporaryConfigDirectory

String getKuraTemporaryConfigDirectory()

Gets the location where all volatile Kura specific configuration and status information should be stored. The convention for each bundle that has filesystem dependencies is for those filesystem components to be stored in the configuration directory root followed by a file separator followed by the project name that needs some configuration. This will keep separate configuration components tied to their appropriate projects.

Returns:

The location of the volatile Kura configuration and status directory root.

getKuraSnapshotsDirectory

String getKuraSnapshotsDirectory()

Gets the location where all Configuration Snapshots will be stored. It is recommended for this directory not to be volatile so that the configuration information can survive reboots and service configuration can be restored.

Returns:

The location of the volatile Kura configuration and status directory root.

getKuraSnapshotsCount

int getKuraSnapshotsCount()

Returns the maximum number of snapshots to be retained in the file system. When the maximum number is reached, a garbage collector will deleted the older snapshots.

Returns:

maximum number of snapshots to be retained.

getKuraStyleDirectory

String getKuraStyleDirectory()

Gets the location where all custom style information is stored.

Returns:

The location of the custom style directory.

getKuraWifiTopChannel

int getKuraWifiTopChannel()

Gets the last wifi channel allowed for this device. In the U.S. this should be 11. In most of Europe this should be 13.

Returns:

The last wifi channel allowed for this device (usually 11 or 13)

getKuraWebEnabled

String getKuraWebEnabled()

getKuraDataDirectory

String getKuraDataDirectory()

Gets the location where all Kura persistent data should be stored.

Returns:

The location of the persistent Kura data directory root.

getProperties

Properties getProperties()

Returns all KuraProperties for this system. The returned instances is initialized by loading the kura.properties file. Properties defined at the System level - for example using the java -D command line flag - are used to overwrite the values loaded from the kura.properties file in a hierarchical configuration fashion.

getBundles

org.osgi.framework.Bundle[] getBundles()

Returns the OSGi bundles currently installed

Returns:

getNumberOfProcessors

int getNumberOfProcessors()

Returns the number of processors visible to this Java platform.

Returns:

getTotalMemory

long getTotalMemory()

Returns the total memory visible to this Java instance.

Returns:

getFreeMemory

long getFreeMemory()

Returns the free memory for Java instance.

Returns:

getJavaKeyStorePassword

char[] getJavaKeyStorePassword()
                               throws InvalidKeyException,
                                      NoSuchAlgorithmException,
                                      NoSuchPaddingException,
                                      IllegalBlockSizeException,
                                      BadPaddingException,
                                      IOException

Returns the password to access the private key from the keystore file.

Returns:

Throws:

InvalidKeyException

NoSuchAlgorithmException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

IOException

getJavaTrustStorePassword

char[] getJavaTrustStorePassword()
                                 throws InvalidKeyException,
                                        NoSuchAlgorithmException,
                                        NoSuchPaddingException,
                                        IllegalBlockSizeException,
                                        BadPaddingException,
                                        IOException

Returns the password to unlock the trust store keystore file.

Returns:

Throws:

InvalidKeyException

NoSuchAlgorithmException

NoSuchPaddingException

IllegalBlockSizeException

BadPaddingException

IOException

getDeviceManagementServiceIgnore

List<String> getDeviceManagementServiceIgnore()

Returns a list of services that should be ignored by the Everyware Cloud Console

Returns: