org.eclipse.mtj.api.extension
Interface DeviceManagement

All Superinterfaces:

org.eclipse.emf.ecore.EObject, MtjExtension, org.eclipse.emf.common.notify.Notifier

public interface DeviceManagement
extends MtjExtension

DeviceManagement provides services to fetch DevicePlatforms, Devices and Device Descriptions. It combines data from DevicePlatformProviders, DeviceDescriptionProviders and DeploymentProviders.

Method Summary

Device[]	getDeployableDevices(DeviceConfiguration deviceConfig, DeviceProfile deviceProfile, ServiceApi[] apis, PlatformType devicePlatformType) Returns all deployment target Device objects that match to the configuration, profile and service api definitions and device platform type.
Device	getDevice(java.lang.String devicePlatformName, java.lang.String deviceName) Returns DevicePlatform's Device whose platform name and device name match.
DeviceDescription	getDeviceDescription(java.lang.String vendor, java.lang.String model) Returns DeviceDescription object baded on the vendor and model.
DeviceGroup[]	getDeviceGroups() Returns all defined device groups.
DevicePlatform	getDevicePlatformByName(java.lang.String name) Returns existing device platform by name.
DevicePlatformProvider	getDevicePlatformProvider(DevicePlatform devicePlatform) Returns the device platform provider that owns the device platform.
DevicePlatform[]	getDevicePlatforms() Returns all existing device platforms.
DeviceDescription[]	getDevices(DeviceConfiguration deviceConfig, DeviceProfile deviceProfile, ServiceApi[] apis) Returns all DeviceDescription objects that match to the configuration, profile and service api definitions.
Device[]	getDevices(java.lang.String devicePlatformName) Returns all devices of the device platform.
DeviceDescription[]	getMatchingDeviceDescriptions(DeviceGroup group) Returns DeviceDescription objects that match to the device group.
RuntimePlatformDefinition[]	getRuntimePlatforms(java.lang.String devicePlatformName, java.lang.String deviceName) Returns all the Runtime Platform Definition of the device platform's device.
Device[]	getTargetDevices(DeviceConfiguration deviceConfig, DeviceProfile deviceProfile, ServiceApi[] apis, PlatformType devicePlatformType) Returns all Device objects that match to the configuration, profile, service api and device platform type.
void	removeDevicePlatform(DevicePlatform devicePlatform) Removes the DevicePlatform from the owner DevicePlatformProdiver if the provider implements the ToolkitSupport interface.

Methods inherited from interface org.eclipse.mtj.api.extension.MtjExtension

getDescription, getId, getType, getVendor, getVersion, isActive, setActive, setDescription, setId, setType, setVendor, setVersion

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getDevicePlatforms

DevicePlatform[] getDevicePlatforms()
                                    throws org.eclipse.mtj.exception.MtjException

Returns all existing device platforms.

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDevicePlatformByName

DevicePlatform getDevicePlatformByName(java.lang.String name)
                                       throws org.eclipse.mtj.exception.MtjException

Returns existing device platform by name.

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDevicePlatformProvider

DevicePlatformProvider getDevicePlatformProvider(DevicePlatform devicePlatform)
                                                 throws org.eclipse.mtj.exception.MtjException

Returns the device platform provider that owns the device platform.

Parameters:

devicePlatform -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDevices

Device[] getDevices(java.lang.String devicePlatformName)
                    throws org.eclipse.mtj.exception.MtjException

Returns all devices of the device platform.

Parameters:

devicePlatformName -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDeviceDescription

DeviceDescription getDeviceDescription(java.lang.String vendor,
                                       java.lang.String model)
                                       throws org.eclipse.mtj.exception.MtjException

Returns DeviceDescription object baded on the vendor and model.

Parameters:

vendor -

model -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getMatchingDeviceDescriptions

DeviceDescription[] getMatchingDeviceDescriptions(DeviceGroup group)
                                                  throws org.eclipse.mtj.exception.MtjException

Returns DeviceDescription objects that match to the device group.

Parameters:

group -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDeviceGroups

DeviceGroup[] getDeviceGroups()
                              throws org.eclipse.mtj.exception.MtjException

Returns all defined device groups.

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDevices

DeviceDescription[] getDevices(DeviceConfiguration deviceConfig,
                               DeviceProfile deviceProfile,
                               ServiceApi[] apis)
                               throws org.eclipse.mtj.exception.MtjException

Returns all DeviceDescription objects that match to the configuration, profile and service api definitions.

Parameters:

deviceConfig -

deviceProfile -

apis -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getTargetDevices

Device[] getTargetDevices(DeviceConfiguration deviceConfig,
                          DeviceProfile deviceProfile,
                          ServiceApi[] apis,
                          PlatformType devicePlatformType)
                          throws org.eclipse.mtj.exception.MtjException

Returns all Device objects that match to the configuration, profile, service api and device platform type.

Parameters:

deviceConfig -

deviceProfile -

apis -

devicePlatformType -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getRuntimePlatforms

RuntimePlatformDefinition[] getRuntimePlatforms(java.lang.String devicePlatformName,
                                                java.lang.String deviceName)
                                                throws org.eclipse.mtj.exception.MtjException

Returns all the Runtime Platform Definition of the device platform's device.

Parameters:

devicePlatformName -

deviceName -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDeployableDevices

Device[] getDeployableDevices(DeviceConfiguration deviceConfig,
                              DeviceProfile deviceProfile,
                              ServiceApi[] apis,
                              PlatformType devicePlatformType)
                              throws org.eclipse.mtj.exception.MtjException

Returns all deployment target Device objects that match to the configuration, profile and service api definitions and device platform type.

Parameters:

deviceConfig -

deviceProfile -

apis -

devicePlatformType -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

getDevice

Device getDevice(java.lang.String devicePlatformName,
                 java.lang.String deviceName)
                 throws org.eclipse.mtj.exception.MtjException

Returns DevicePlatform's Device whose platform name and device name match.

Parameters:

devicePlatformName -

deviceName -

Returns:

Throws:

org.eclipse.mtj.exception.MtjException

removeDevicePlatform

void removeDevicePlatform(DevicePlatform devicePlatform)
                          throws org.eclipse.mtj.exception.MtjException

Removes the DevicePlatform from the owner DevicePlatformProdiver if the provider implements the ToolkitSupport interface.

Parameters:

devicePlatform -

Throws:

org.eclipse.mtj.exception.MtjException