org.eclipse.kura.system

Interface SystemService

@ProviderType
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 java.lang.String	CONFIG_CONSOLE_DEVICE_MANAGE_SERVICE_IGNORE
static java.lang.String	DB_CACHE_ROWS_PROPNAME Deprecated.
static java.lang.String	DB_DEFRAG_LIMIT_PROPNAME Deprecated.
static java.lang.String	DB_LOB_FILE_PROPNAME Deprecated.
static java.lang.String	DB_LOG_DATA_PROPNAME Deprecated.
static java.lang.String	DB_LOG_SIZE_PROPNAME Deprecated.
static java.lang.String	DB_NIO_PROPNAME Deprecated.
static java.lang.String	DB_URL_PROPNAME Deprecated.
static java.lang.String	DB_WRITE_DELAY_MILLIES_PROPNAME Deprecated.
static java.lang.String	KEY_BIOS_VERSION
static java.lang.String	KEY_DEVICE_NAME
static java.lang.String	KEY_FILE_COMMAND_ZIP_MAX_NUMBER
static java.lang.String	KEY_FILE_COMMAND_ZIP_MAX_SIZE
static java.lang.String	KEY_FILE_SEP
static java.lang.String	KEY_FIRMWARE_VERSION
static java.lang.String	KEY_JAVA_HOME
static java.lang.String	KEY_JAVA_VENDOR
static java.lang.String	KEY_JAVA_VERSION
static java.lang.String	KEY_JAVA_VM_INFO
static java.lang.String	KEY_JAVA_VM_NAME
static java.lang.String	KEY_JAVA_VM_VERSION
static java.lang.String	KEY_KURA_DATA_DIR
static java.lang.String	KEY_KURA_HAVE_NET_ADMIN
static java.lang.String	KEY_KURA_HAVE_WEB_INTER
static java.lang.String	KEY_KURA_HOME_DIR
static java.lang.String	KEY_KURA_KEY_STORE_PWD
static java.lang.String	KEY_KURA_MARKETPLACE_COMPATIBILITY_VERSION
static java.lang.String	KEY_KURA_NAME
static java.lang.String	KEY_KURA_PACKAGES_DIR
static java.lang.String	KEY_KURA_PLUGINS_DIR
static java.lang.String	KEY_KURA_SNAPSHOTS_COUNT
static java.lang.String	KEY_KURA_SNAPSHOTS_DIR
static java.lang.String	KEY_KURA_STYLE_DIR
static java.lang.String	KEY_KURA_TMP_DIR
static java.lang.String	KEY_KURA_TRUST_STORE_PWD
static java.lang.String	KEY_KURA_VERSION
static java.lang.String	KEY_KURA_WIFI_TOP_CHANNEL
static java.lang.String	KEY_MODEL_ID
static java.lang.String	KEY_MODEL_NAME
static java.lang.String	KEY_OS_ARCH
static java.lang.String	KEY_OS_DISTRO
static java.lang.String	KEY_OS_DISTRO_VER
static java.lang.String	KEY_OS_NAME
static java.lang.String	KEY_OS_VER
static java.lang.String	KEY_OSGI_FW_NAME
static java.lang.String	KEY_OSGI_FW_VERSION
static java.lang.String	KEY_PART_NUMBER
static java.lang.String	KEY_PLATFORM
static java.lang.String	KEY_PRIMARY_NET_IFACE
static java.lang.String	KEY_SERIAL_NUM
static java.lang.String	KURA_CONFIG
static java.lang.String	KURA_CUSTOM_CONFIG
static java.lang.String	KURA_CUSTOM_PROPS_FILE
static java.lang.String	KURA_PROPS_FILE
static java.lang.String	OS_CLOUDBEES
static java.lang.String	OS_LINUX
static java.lang.String	OS_MAC_OSX
static java.lang.String	UNKNOWN
static java.lang.String	UNSUPPORTED

Method Summary

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

Field Detail

KURA_CONFIG

static final java.lang.String KURA_CONFIG

See Also:

Constant Field Values

KURA_PROPS_FILE

static final java.lang.String KURA_PROPS_FILE

See Also:

Constant Field Values

KURA_CUSTOM_CONFIG

static final java.lang.String KURA_CUSTOM_CONFIG

See Also:

Constant Field Values

KURA_CUSTOM_PROPS_FILE

static final java.lang.String KURA_CUSTOM_PROPS_FILE

See Also:

Constant Field Values

OS_CLOUDBEES

static final java.lang.String OS_CLOUDBEES

See Also:

Constant Field Values

OS_LINUX

static final java.lang.String OS_LINUX

See Also:

Constant Field Values

OS_MAC_OSX

static final java.lang.String OS_MAC_OSX

See Also:

Constant Field Values

UNKNOWN

static final java.lang.String UNKNOWN

See Also:

Constant Field Values

UNSUPPORTED

static final java.lang.String UNSUPPORTED

See Also:

Constant Field Values

KEY_KURA_NAME

static final java.lang.String KEY_KURA_NAME

See Also:

Constant Field Values

KEY_KURA_VERSION

static final java.lang.String KEY_KURA_VERSION

See Also:

Constant Field Values

KEY_KURA_MARKETPLACE_COMPATIBILITY_VERSION

static final java.lang.String KEY_KURA_MARKETPLACE_COMPATIBILITY_VERSION

Since:

1.3

See Also:

Constant Field Values

KEY_DEVICE_NAME

static final java.lang.String KEY_DEVICE_NAME

See Also:

Constant Field Values

KEY_PLATFORM

static final java.lang.String KEY_PLATFORM

See Also:

Constant Field Values

KEY_MODEL_ID

static final java.lang.String KEY_MODEL_ID

See Also:

Constant Field Values

KEY_MODEL_NAME

static final java.lang.String KEY_MODEL_NAME

See Also:

Constant Field Values

KEY_PART_NUMBER

static final java.lang.String KEY_PART_NUMBER

See Also:

Constant Field Values

KEY_SERIAL_NUM

static final java.lang.String KEY_SERIAL_NUM

See Also:

Constant Field Values

KEY_BIOS_VERSION

static final java.lang.String KEY_BIOS_VERSION

See Also:

Constant Field Values

KEY_FIRMWARE_VERSION

static final java.lang.String KEY_FIRMWARE_VERSION

See Also:

Constant Field Values

KEY_PRIMARY_NET_IFACE

static final java.lang.String KEY_PRIMARY_NET_IFACE

See Also:

Constant Field Values

KEY_KURA_HOME_DIR

static final java.lang.String KEY_KURA_HOME_DIR

See Also:

Constant Field Values

KEY_KURA_PLUGINS_DIR

static final java.lang.String KEY_KURA_PLUGINS_DIR

See Also:

Constant Field Values

KEY_KURA_PACKAGES_DIR

static final java.lang.String KEY_KURA_PACKAGES_DIR

Since:

1.2

See Also:

Constant Field Values

KEY_KURA_DATA_DIR

static final java.lang.String KEY_KURA_DATA_DIR

See Also:

Constant Field Values

KEY_KURA_TMP_DIR

static final java.lang.String KEY_KURA_TMP_DIR

See Also:

Constant Field Values

KEY_KURA_SNAPSHOTS_DIR

static final java.lang.String KEY_KURA_SNAPSHOTS_DIR

See Also:

Constant Field Values

KEY_KURA_SNAPSHOTS_COUNT

static final java.lang.String KEY_KURA_SNAPSHOTS_COUNT

See Also:

Constant Field Values

KEY_KURA_HAVE_NET_ADMIN

static final java.lang.String KEY_KURA_HAVE_NET_ADMIN

See Also:

Constant Field Values

KEY_KURA_HAVE_WEB_INTER

static final java.lang.String KEY_KURA_HAVE_WEB_INTER

See Also:

Constant Field Values

KEY_KURA_STYLE_DIR

static final java.lang.String KEY_KURA_STYLE_DIR

See Also:

Constant Field Values

KEY_KURA_WIFI_TOP_CHANNEL

static final java.lang.String KEY_KURA_WIFI_TOP_CHANNEL

See Also:

Constant Field Values

KEY_KURA_KEY_STORE_PWD

static final java.lang.String KEY_KURA_KEY_STORE_PWD

See Also:

Constant Field Values

KEY_KURA_TRUST_STORE_PWD

static final java.lang.String KEY_KURA_TRUST_STORE_PWD

See Also:

Constant Field Values

KEY_FILE_COMMAND_ZIP_MAX_SIZE

static final java.lang.String KEY_FILE_COMMAND_ZIP_MAX_SIZE

See Also:

Constant Field Values

KEY_FILE_COMMAND_ZIP_MAX_NUMBER

static final java.lang.String KEY_FILE_COMMAND_ZIP_MAX_NUMBER

See Also:

Constant Field Values

KEY_OS_ARCH

static final java.lang.String KEY_OS_ARCH

See Also:

Constant Field Values

KEY_OS_NAME

static final java.lang.String KEY_OS_NAME

See Also:

Constant Field Values

KEY_OS_VER

static final java.lang.String KEY_OS_VER

See Also:

Constant Field Values

KEY_OS_DISTRO

static final java.lang.String KEY_OS_DISTRO

See Also:

Constant Field Values

KEY_OS_DISTRO_VER

static final java.lang.String KEY_OS_DISTRO_VER

See Also:

Constant Field Values

KEY_JAVA_VERSION

static final java.lang.String KEY_JAVA_VERSION

See Also:

Constant Field Values

KEY_JAVA_VENDOR

static final java.lang.String KEY_JAVA_VENDOR

See Also:

Constant Field Values

KEY_JAVA_VM_NAME

static final java.lang.String KEY_JAVA_VM_NAME

See Also:

Constant Field Values

KEY_JAVA_VM_VERSION

static final java.lang.String KEY_JAVA_VM_VERSION

See Also:

Constant Field Values

KEY_JAVA_VM_INFO

static final java.lang.String KEY_JAVA_VM_INFO

See Also:

Constant Field Values

KEY_OSGI_FW_NAME

static final java.lang.String KEY_OSGI_FW_NAME

See Also:

Constant Field Values

KEY_OSGI_FW_VERSION

static final java.lang.String KEY_OSGI_FW_VERSION

See Also:

Constant Field Values

KEY_JAVA_HOME

static final java.lang.String KEY_JAVA_HOME

See Also:

Constant Field Values

KEY_FILE_SEP

static final java.lang.String KEY_FILE_SEP

See Also:

Constant Field Values

CONFIG_CONSOLE_DEVICE_MANAGE_SERVICE_IGNORE

static final java.lang.String CONFIG_CONSOLE_DEVICE_MANAGE_SERVICE_IGNORE

See Also:

Constant Field Values

DB_URL_PROPNAME

@Deprecated
static final java.lang.String DB_URL_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_WRITE_DELAY_MILLIES_PROPNAME

@Deprecated
static final java.lang.String DB_WRITE_DELAY_MILLIES_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_LOG_DATA_PROPNAME

@Deprecated
static final java.lang.String DB_LOG_DATA_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_CACHE_ROWS_PROPNAME

@Deprecated
static final java.lang.String DB_CACHE_ROWS_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_LOB_FILE_PROPNAME

@Deprecated
static final java.lang.String DB_LOB_FILE_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_DEFRAG_LIMIT_PROPNAME

@Deprecated
static final java.lang.String DB_DEFRAG_LIMIT_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_LOG_SIZE_PROPNAME

@Deprecated
static final java.lang.String DB_LOG_SIZE_PROPNAME

Deprecated.

See Also:

Constant Field Values

DB_NIO_PROPNAME

@Deprecated
static final java.lang.String DB_NIO_PROPNAME

Deprecated.

See Also:

Constant Field Values

Method Detail

getPrimaryMacAddress

java.lang.String getPrimaryMacAddress()

Gets the primary MAC address of the system

Returns:

getPrimaryNetworkInterfaceName

java.lang.String getPrimaryNetworkInterfaceName()

Gets the name of the 'primary' network interface.

Returns:

getPlatform

java.lang.String getPlatform()

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

Returns:

The platform name.

getModelId

java.lang.String getModelId()

Gets the model identification of the device.

Returns:

Model ID.

getModelName

java.lang.String getModelName()

Gets the model name of the device.

Returns:

Model name.

getPartNumber

java.lang.String getPartNumber()

Gets the part number.

Returns:

Part number.

getSerialNumber

java.lang.String getSerialNumber()

Gets the serial number of the device.

Returns:

Serial number.

getDeviceName

java.lang.String getDeviceName()

Returns a friendly name assigned to this device.

Returns:

getBiosVersion

java.lang.String getBiosVersion()

Gets the BIOS version of the device.

Returns:

BIOS version.

getFirmwareVersion

java.lang.String getFirmwareVersion()

Gets the firmware version.

Returns:

Firmware version.

getOsArch

java.lang.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

java.lang.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

java.lang.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

java.lang.String getOsDistro()

Gets the Operating System Distribution name if appropriate.

Returns:

A String representing the Operating System Distribution name if appropriate.

getOsDistroVersion

java.lang.String getOsDistroVersion()

Gets the Operating System Distribution version if appropriate.

Returns:

A String representing the Operating System Distribution version if appropriate.

getJavaVendor

java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.lang.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

java.lang.String getFileSeparator()

Gets the system file separator used by the filesystem.

Returns:

The system file separator used by the system.

getJavaHome

java.lang.String getJavaHome()

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

Returns:

The location of the root JVM directory.

getKuraVersion

java.lang.String getKuraVersion()

Gets the product version for this unit. The product version is defined in the kura.version property of the kura.properties file located in the ${BASE_DIR}/${KURA_SYMLINK}/kura directory.

Returns:

The Kura version string as denoted in kura.version property of the kura.properties file.

getKuraMarketplaceCompatibilityVersion

java.lang.String getKuraMarketplaceCompatibilityVersion()

Gets the Eclipse Marketplace compatibility product version for this unit. The marketplace compatibility product version is defined in the kura.marketplace.compatibility.version property of the kura.properties file located in the ${BASE_DIR}/${KURA_SYMLINK}/kura directory. If the variable kura.marketplace.compatibility.version cannot be located, it defaults to the value specified by getKuraVersion().

Returns:

The marketplace compatibility Kura version string.

Since:

1.3

getKuraHome

java.lang.String getKuraHome()

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

Returns:

The root Kura directory.

getKuraTemporaryConfigDirectory

java.lang.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

java.lang.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 delete the older snapshots.

Returns:

maximum number of snapshots to be retained.

getKuraStyleDirectory

java.lang.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

java.lang.String getKuraWebEnabled()

getKuraDataDirectory

java.lang.String getKuraDataDirectory()

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

Returns:

The location of the persistent Kura data directory root.

getFileCommandZipMaxUploadSize

int getFileCommandZipMaxUploadSize()

Returns the size in MegaBytes of the maximum file upload size permitted by the local file servlet

Returns:

The maximum size (in mega bytes) of files that can be uploaded using the command file upload function

getFileCommandZipMaxUploadNumber

int getFileCommandZipMaxUploadNumber()

Returns the maximum number of files that can be uploaded by the local file servlet

Returns:

The maximum number of files that can be uploaded using the command file upload function

getProperties

java.util.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 in kilobytes.

Returns:

getFreeMemory

long getFreeMemory()

Returns the free memory for Java instance in kilobytes.

Returns:

getJavaKeyStorePassword

char[] getJavaKeyStorePassword()
                        throws java.security.InvalidKeyException,
                               java.security.NoSuchAlgorithmException,
                               javax.crypto.NoSuchPaddingException,
                               javax.crypto.IllegalBlockSizeException,
                               javax.crypto.BadPaddingException,
                               java.io.IOException

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

Returns:

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

java.io.IOException

getJavaTrustStorePassword

char[] getJavaTrustStorePassword()
                          throws java.security.InvalidKeyException,
                                 java.security.NoSuchAlgorithmException,
                                 javax.crypto.NoSuchPaddingException,
                                 javax.crypto.IllegalBlockSizeException,
                                 javax.crypto.BadPaddingException,
                                 java.io.IOException

Returns the password to unlock the trust store keystore file.

Returns:

Throws:

java.security.InvalidKeyException

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

java.io.IOException

getDeviceManagementServiceIgnore

java.util.List<java.lang.String> getDeviceManagementServiceIgnore()

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

Returns: