org.ws4d.java.service

Class DeviceCommons

java.lang.Object

org.ws4d.java.service.DeviceCommons

All Implemented Interfaces:

Device

Direct Known Subclasses:

DefaultDevice, ProxyDevice

public abstract class DeviceCommons
extends java.lang.Object
implements Device

Class represents the common part of a proxy/local device also known as Hosting Service .

Field Summary

Fields

Modifier and Type	Field and Description
HashMap	customMData Additional custom metadata of this device -> Elements = UnknownDataContainer
ThisDeviceMData	deviceMetadata Device data locally set, or created with wsd:Get.
ThisModelMData	modelMetadata Model data locally set, or created with wsd:Get.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeviceCommons() Default constructor.
protected	DeviceCommons(ThisModelMData modelMetadata, ThisDeviceMData deviceMetadata) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract void	disconnectAllServiceReferences(boolean resetServiceRefs) Disconnects all ServiceReferences from device.
boolean	equals(java.lang.Object obj)
UnknownDataContainer[]	getCustomMData(java.lang.String communicationManagerId) The method returns all custom metadata
java.lang.String	getFirmwareVersion() Gets firmware version.
java.lang.String	getFriendlyName(java.lang.String lang) Gets friendly name of device.
Iterator	getFriendlyNames() Gets iterator over all friendly names of device.
java.lang.String	getManufacturer(java.lang.String lang) Gets manufacturer by language.
Iterator	getManufacturers() Gets all manufacturers as iterator over manufacterer names.
java.lang.String	getManufacturerUrl() Gets the url of the manufacturer.
java.lang.String	getModelName(java.lang.String lang) Gets model name by language.
Iterator	getModelNames() Gets all model names as iterator over model names.
java.lang.String	getModelNumber() Gets model number of device.
java.lang.String	getModelUrl() Gets model url of device.
java.lang.String	getPresentationUrl() Gets presentation url of device.
java.lang.String	getSerialNumber() Gets serial number.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ws4d.java.service.Device

addMatchingServiceReferencesToDataStructure, getComManId, getDefaultNamespace, getDeviceReference, getDiscoveryXAddressInfos, getEndpointReference, getMetadataVersion, getPortTypes, getScopes, getServiceReference, getServiceReference, getServiceReferences, getServiceReferences, getTransportAndDiscoveryXAddressInfos, getTransportXAddressInfos, invalidate, isRemote, isValid

Field Detail

modelMetadata

public ThisModelMData modelMetadata

Model data locally set, or created with wsd:Get.

deviceMetadata

public ThisDeviceMData deviceMetadata

Device data locally set, or created with wsd:Get.

customMData

public HashMap customMData

Additional custom metadata of this device -> Elements = UnknownDataContainer

Constructor Detail

DeviceCommons

protected DeviceCommons()

Default constructor. Creates empty model metadata ThisModelMData and device metadata ThisDeviceMData. The metadata is part of the get response message GetResponseMessage.

DeviceCommons

protected DeviceCommons(ThisModelMData modelMetadata,
                        ThisDeviceMData deviceMetadata)

Constructor. The specified metadata will be set to fields of the device. The metadata is part of the get response message GetResponseMessage.

Parameters:

modelMetadata - This model metadata is part of the get response message GetResponseMessage.

deviceMetadata - This device metadata is part of the get response message GetResponseMessage.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getManufacturer

public java.lang.String getManufacturer(java.lang.String lang)

Description copied from interface: Device

Gets manufacturer by language. Language consts are specified in LocalizedString.

Specified by:

getManufacturer in interface Device

Parameters:

lang - The language of the manufacturer's name to be obtained. The language consts are specified in LocalizedString.

Returns:

Manufacturer's name in specified language of type LocalizedString.

getManufacturers

public Iterator getManufacturers()

Description copied from interface: Device

Gets all manufacturers as iterator over manufacterer names. A single manufacturer name is of type LocalizedString.

Specified by:

getManufacturers in interface Device

Returns:

Iterator over manufacturer of type LocalizedString.

getManufacturerUrl

public java.lang.String getManufacturerUrl()

Description copied from interface: Device

Gets the url of the manufacturer.

Specified by:

getManufacturerUrl in interface Device

Returns:

Url of manufacturer

getModelName

public java.lang.String getModelName(java.lang.String lang)

Description copied from interface: Device

Gets model name by language. Language consts are specified in LocalizedString.

Specified by:

getModelName in interface Device

Parameters:

lang - Language of the model name to get. The language consts are specified in LocalizedString.

Returns:

Model name in specified language of type LocalizedString.

getModelNames

public Iterator getModelNames()

Description copied from interface: Device

Gets all model names as iterator over model names. A single model name is of type LocalizedString.

Specified by:

getModelNames in interface Device

Returns:

Iterator over model names of type LocalizedString.

getModelNumber

public java.lang.String getModelNumber()

Description copied from interface: Device

Gets model number of device.

Specified by:

getModelNumber in interface Device

Returns:

Model number.

getModelUrl

public java.lang.String getModelUrl()

Description copied from interface: Device

Gets model url of device.

Specified by:

getModelUrl in interface Device

Returns:

Model url.

getPresentationUrl

public java.lang.String getPresentationUrl()

Description copied from interface: Device

Gets presentation url of device.

Specified by:

getPresentationUrl in interface Device

Returns:

Presentation url.

getFriendlyName

public java.lang.String getFriendlyName(java.lang.String lang)

Description copied from interface: Device

Gets friendly name of device.

Specified by:

getFriendlyName in interface Device

Parameters:

lang - language of friendly name

Returns:

Friendly name of type LocalizedString in specified language

getFriendlyNames

public Iterator getFriendlyNames()

Description copied from interface: Device

Gets iterator over all friendly names of device. A single name is of type LocalizedString.

Specified by:

getFriendlyNames in interface Device

Returns:

Iterator over friendly names of type LocalizedString.

getFirmwareVersion

public java.lang.String getFirmwareVersion()

Description copied from interface: Device

Gets firmware version.

Specified by:

getFirmwareVersion in interface Device

Returns:

firmware version

getSerialNumber

public java.lang.String getSerialNumber()

Description copied from interface: Device

Gets serial number.

Specified by:

getSerialNumber in interface Device

Returns:

serial number

getCustomMData

public UnknownDataContainer[] getCustomMData(java.lang.String communicationManagerId)

Description copied from interface: Device

The method returns all custom metadata

Specified by:

getCustomMData in interface Device

Returns:

UnknownDataContainer[] which contains the custom metadata

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

disconnectAllServiceReferences

public abstract void disconnectAllServiceReferences(boolean resetServiceRefs)

Disconnects all ServiceReferences from device. If resetServiceRefs is true serviceReferences will be reseted too.

Parameters:

resetServiceRefs -