org.ws4d.java.service

Interface Device

All Known Subinterfaces:

LocalDevice

All Known Implementing Classes:

DefaultDevice, DeviceCommons, ProxyDevice

public interface Device

Device. "DPWS Hosting Service" This is the most common interface of all devices.

A device is a web service with specific functions. It can be discovered via probing from clients and it supports resolving of its endpoint. A device bears services. A device is encapsulated in a DeviceReference.

Method Summary

Modifier and Type	Method and Description
void	addMatchingServiceReferencesToDataStructure(DataStructure to, QNameSet serviceTypes, SecurityKey securityKey) Adds service references associated to this device to the data structure to, if they match the service port types given within serviceTypes.
java.lang.String	getComManId()
UnknownDataContainer[]	getCustomMData(java.lang.String communicationManagerId) The method returns all custom metadata
java.lang.String	getDefaultNamespace() return the default namespace.
DeviceReference	getDeviceReference(SecurityKey securityKey) Gets the DeviceReference of this device.
Iterator	getDiscoveryXAddressInfos() Returns a iterator over the discovery addresses of this device.
EndpointReference	getEndpointReference() Returns the endpoint reference of this device.
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.
long	getMetadataVersion() Returns metadata version for this device.
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.
Iterator	getPortTypes() Gets the iterator over device port types of the device.
java.lang.String	getPresentationUrl() Gets presentation url of device.
Iterator	getScopes() Gets iterator over all scopes of the device.
java.lang.String	getSerialNumber() Gets serial number.
ServiceReference	getServiceReference(EndpointReference serviceEpr, SecurityKey securityKey) Get service reference by endpoint reference of referenced service.
ServiceReference	getServiceReference(URI serviceId, SecurityKey securityKey) Gets service reference by service id of referenced service.
Iterator	getServiceReferences(QNameSet servicePortTypes, SecurityKey securityKey) Gets iterator over the service reference of the services, which implements all port types specified.
Iterator	getServiceReferences(SecurityKey securityKey) Gets iterator over the service references of all services.
Iterator	getTransportAndDiscoveryXAddressInfos() Returns a iterator over the combination of transport and discovery addresses of this device.
Iterator	getTransportXAddressInfos() Returns a iterator over the transport addresses of this device.
void	invalidate() set the device on invalid.
boolean	isRemote() Is device remote (proxy) or local?
boolean	isValid() return true if device is valid and false if it is invalid.

Method Detail

getEndpointReference

EndpointReference getEndpointReference()

Returns the endpoint reference of this device. This endpoint reference is a unique identifier for the device.

Returns:

endpoint reference as unique identifier.

getMetadataVersion

long getMetadataVersion()

Returns metadata version for this device. The metadata version is transmitted via discovery messages.

Returns:

metadata version as unsigned integer.

getTransportXAddressInfos

Iterator getTransportXAddressInfos()

Returns a iterator over the transport addresses of this device. The type of the addresses is URI.

Returns:

Iterator over transport addresses of type URI.

getDiscoveryXAddressInfos

Iterator getDiscoveryXAddressInfos()

Returns a iterator over the discovery addresses of this device. The type of the addresses is URI.

Returns:

Iterator over discovery addresses of type URI.

getTransportAndDiscoveryXAddressInfos

Iterator getTransportAndDiscoveryXAddressInfos()

Returns a iterator over the combination of transport and discovery addresses of this device. The type of the addresses is URI.

Returns:

Iterator over discovery addresses of type URI.

getPortTypes

Iterator getPortTypes()

Gets the iterator over device port types of the device. The port types are of type QName.

Returns:

Iterator over device port types of type QName.

getManufacturer

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

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

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

Iterator getManufacturers()

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

Returns:

Iterator over manufacturer of type LocalizedString.

getManufacturerUrl

java.lang.String getManufacturerUrl()

Gets the url of the manufacturer.

Returns:

Url of manufacturer

getModelName

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

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

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

Iterator getModelNames()

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

Returns:

Iterator over model names of type LocalizedString.

getModelNumber

java.lang.String getModelNumber()

Gets model number of device.

Returns:

Model number.

getModelUrl

java.lang.String getModelUrl()

Gets model url of device.

Returns:

Model url.

getPresentationUrl

java.lang.String getPresentationUrl()

Gets presentation url of device.

Returns:

Presentation url.

getFriendlyName

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

Gets friendly name of device.

Parameters:

lang - language of friendly name

Returns:

Friendly name of type LocalizedString in specified language

getFriendlyNames

Iterator getFriendlyNames()

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

Returns:

Iterator over friendly names of type LocalizedString.

getFirmwareVersion

java.lang.String getFirmwareVersion()

Gets firmware version.

Returns:

firmware version

getSerialNumber

java.lang.String getSerialNumber()

Gets serial number.

Returns:

serial number

getServiceReferences

Iterator getServiceReferences(SecurityKey securityKey)

Gets iterator over the service references of all services. A service reference is of type ServiceReference.

Returns:

Iterator over the (@link ServiceReference) of each service of the device.

getServiceReferences

Iterator getServiceReferences(QNameSet servicePortTypes,
                              SecurityKey securityKey)

Gets iterator over the service reference of the services, which implements all port types specified. A service reference is of type ServiceReference.

Parameters:

servicePortTypes - The service port types the services must implement, to be returned by its reference.

Returns:

Iterator over the (@link ServiceReferences) to the services of the device, which implements the specified service port types.

addMatchingServiceReferencesToDataStructure

void addMatchingServiceReferencesToDataStructure(DataStructure to,
                                                 QNameSet serviceTypes,
                                                 SecurityKey securityKey)

Adds service references associated to this device to the data structure to, if they match the service port types given within serviceTypes.

Parameters:

to - collection to add matching service references to

serviceTypes - service port types to look for

getServiceReference

ServiceReference getServiceReference(URI serviceId,
                                     SecurityKey securityKey)

Gets service reference by service id of referenced service. Service id is compared as case-sensitive string.

Parameters:

serviceId -

Returns:

service reference, or null if no service matches the service id.

getServiceReference

ServiceReference getServiceReference(EndpointReference serviceEpr,
                                     SecurityKey securityKey)

Get service reference by endpoint reference of referenced service.

Parameters:

serviceEpr -

Returns:

service reference, or null, if no service matches the service id.

isRemote

boolean isRemote()

Is device remote (proxy) or local?

Returns:

whether this is a remote device (proxy) or not

getScopes

Iterator getScopes()

Gets iterator over all scopes of the device. A scope is of type URI.

Returns:

Iterator over all scopes of type URI.

getDeviceReference

DeviceReference getDeviceReference(SecurityKey securityKey)

Gets the DeviceReference of this device.

Returns:

The DeviceReference of this device.

getDefaultNamespace

java.lang.String getDefaultNamespace()

return the default namespace.

Returns:

default namespace

isValid

boolean isValid()

return true if device is valid and false if it is invalid.

Returns:

valid

invalidate

void invalidate()

set the device on invalid.

getCustomMData

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

The method returns all custom metadata

Returns:

UnknownDataContainer[] which contains the custom metadata

getComManId

java.lang.String getComManId()