org.ws4d.java.service

Class ProxyDevice

java.lang.Object

org.ws4d.java.service.DeviceCommons

org.ws4d.java.service.ProxyDevice

All Implemented Interfaces:

Device

public class ProxyDevice
extends DeviceCommons

Proxy class of a (remote) device

Field Summary

Fields inherited from class org.ws4d.java.service.DeviceCommons

customMData, deviceMetadata, modelMetadata

Constructor Summary

Constructors

Constructor and Description
ProxyDevice(GetResponseMessage message, DefaultDeviceReference devRef, Device oldDevice, ConnectionInfo connectionInfo) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addMatchingServiceReferencesToDataStructure(DataStructure to, QNameSet servicePortTypes, SecurityKey securityKey) Adds service references associated to this device to the data structure to, if they match the service port types given within serviceTypes.
void	disconnectAllServiceReferences(boolean resetServiceRefs) Disconnects all ServiceReferences from device.
java.lang.String	getComManId()
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.
long	getMetadataVersion() Returns metadata version for this device.
Iterator	getPortTypes() Gets the iterator over device port types of the device.
Iterator	getScopes() Gets iterator over all scopes of the device.
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.

Methods inherited from class org.ws4d.java.service.DeviceCommons

equals, getCustomMData, getFirmwareVersion, getFriendlyName, getFriendlyNames, getManufacturer, getManufacturers, getManufacturerUrl, getModelName, getModelNames, getModelNumber, getModelUrl, getPresentationUrl, getSerialNumber, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyDevice

public ProxyDevice(GetResponseMessage message,
                   DefaultDeviceReference devRef,
                   Device oldDevice,
                   ConnectionInfo connectionInfo)

Constructor. Constructs device proxy by get response message.

Parameters:

message - Holds information about discovered device.

Method Detail

isRemote

public boolean isRemote()

Description copied from interface: Device

Is device remote (proxy) or local?

Returns:

whether this is a remote device (proxy) or not

getEndpointReference

public EndpointReference getEndpointReference()

Description copied from interface: Device

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

Returns:

endpoint reference as unique identifier.

getPortTypes

public Iterator getPortTypes()

Description copied from interface: Device

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.

getMetadataVersion

public long getMetadataVersion()

Description copied from interface: Device

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

Returns:

metadata version as unsigned integer.

getDeviceReference

public DeviceReference getDeviceReference(SecurityKey securityKey)

Description copied from interface: Device

Gets the DeviceReference of this device.

Returns:

The DeviceReference of this device.

getTransportXAddressInfos

public Iterator getTransportXAddressInfos()

Description copied from interface: Device

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

public Iterator getDiscoveryXAddressInfos()

Description copied from interface: Device

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

public Iterator getTransportAndDiscoveryXAddressInfos()

Description copied from interface: Device

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.

getScopes

public Iterator getScopes()

Description copied from interface: Device

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

Returns:

Iterator over all scopes of type URI.

getServiceReferences

public Iterator getServiceReferences(SecurityKey securityKey)

Description copied from interface: Device

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

public Iterator getServiceReferences(QNameSet servicePortTypes,
                                     SecurityKey securityKey)

Description copied from interface: Device

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

public void addMatchingServiceReferencesToDataStructure(DataStructure to,
                                                        QNameSet servicePortTypes,
                                                        SecurityKey securityKey)

Description copied from interface: Device

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

servicePortTypes - service port types to look for

getServiceReference

public ServiceReference getServiceReference(URI serviceId,
                                            SecurityKey securityKey)

Description copied from interface: Device

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

Returns:

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

getServiceReference

public ServiceReference getServiceReference(EndpointReference serviceEpr,
                                            SecurityKey securityKey)

Description copied from interface: Device

Get service reference by endpoint reference of referenced service.

Returns:

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

disconnectAllServiceReferences

public void disconnectAllServiceReferences(boolean resetServiceRefs)

Description copied from class: DeviceCommons

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

Specified by:

disconnectAllServiceReferences in class DeviceCommons

getDefaultNamespace

public java.lang.String getDefaultNamespace()

Description copied from interface: Device

return the default namespace.

Returns:

default namespace

isValid

public boolean isValid()

Description copied from interface: Device

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

Returns:

valid

invalidate

public void invalidate()

Description copied from interface: Device

set the device on invalid.

getComManId

public java.lang.String getComManId()