Package org.somda.sdc.dpws.device

Class DeviceImpl

java.lang.Object

com.google.common.util.concurrent.AbstractIdleService

org.somda.sdc.dpws.device.DeviceImpl

All Implemented Interfaces:

com.google.common.util.concurrent.Service, Device, DiscoveryAccess, HostingServiceAccess

public class DeviceImpl
extends com.google.common.util.concurrent.AbstractIdleService
implements Device, com.google.common.util.concurrent.Service, DiscoveryAccess, HostingServiceAccess

Default implementation of Device, DiscoveryAccess and HostingServiceAccess.

todo DGr no support for hosting and hosted services being updated during runtime.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method	Description
void	addHostedService(HostedService hostedService)	Adds a hosted service definition.
Map<String,SubscriptionManager>	getActiveSubscriptions()
DiscoveryAccess	getDiscoveryAccess()	Gets access to WS-Discovery in order to configure types and scopes.
String	getEprAddress()
HostingServiceAccess	getHostingServiceAccess()	Gets access to Hosting Service metadata and Hosted Services.
void	sendHello()	Sends a Hello message to the network.
void	setScopes(Collection<String> scopes)	Sets the scopes in accordance with WS-Discovery.
void	setThisDevice(ThisDeviceType thisDevice)	Adds the ThisModel definition.
void	setThisModel(ThisModelType thisModel)	Updates the ThisModel definition.
void	setTypes(Collection<QName> types)	Sets the types in accordance with WS-Discovery.
protected void	shutDown()
protected void	startUp()

Methods inherited from class com.google.common.util.concurrent.AbstractIdleService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, executor, failureCause, isRunning, serviceName, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Method Details

startUp

protected void startUp()
                throws Exception

Specified by:

startUp in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

shutDown

protected void shutDown()
                 throws Exception

Specified by:

shutDown in class com.google.common.util.concurrent.AbstractIdleService

Throws:

Exception

getActiveSubscriptions

public Map<String,SubscriptionManager> getActiveSubscriptions()

Specified by:

getActiveSubscriptions in interface Device

getDiscoveryAccess

public DiscoveryAccess getDiscoveryAccess()

Description copied from interface: Device

Gets access to WS-Discovery in order to configure types and scopes.

Specified by:

getDiscoveryAccess in interface Device

Returns:

discovery access.

getHostingServiceAccess

public HostingServiceAccess getHostingServiceAccess()

Description copied from interface: Device

Gets access to Hosting Service metadata and Hosted Services.

Specified by:

getHostingServiceAccess in interface Device

Returns:

hosting service access.

getEprAddress

public String getEprAddress()

Specified by:

getEprAddress in interface Device

setTypes

public void setTypes(Collection<QName> types)

Description copied from interface: DiscoveryAccess

Sets the types in accordance with WS-Discovery.

Specified by:

setTypes in interface DiscoveryAccess

Parameters:

types - the types to set.

See Also:

• Matching Types and Scopes

setScopes

public void setScopes(Collection<String> scopes)

Description copied from interface: DiscoveryAccess

Sets the scopes in accordance with WS-Discovery.

Specified by:

setScopes in interface DiscoveryAccess

Parameters:

scopes - the scopes to set.

See Also:

• Matching Types and Scopes

sendHello

public void sendHello()

Description copied from interface: DiscoveryAccess

Sends a Hello message to the network.

The Hello message will be sent only if DiscoveryAccess.setScopes(Collection) or DiscoveryAccess.setTypes(Collection) has been called prior to this function. This needs to be repeated for every Hello to be sent.

Specified by:

sendHello in interface DiscoveryAccess

setThisDevice

public void setThisDevice(ThisDeviceType thisDevice)

Description copied from interface: HostingServiceAccess

Adds the ThisModel definition.

According to the DPWS specification, certain information is limited in the number of characters:

• ThisDeviceType.getFriendlyName() shall have fewer than DpwsConstants.MAX_FIELD_SIZE octets
• ThisDeviceType.getFirmwareVersion() shall have fewer than DpwsConstants.MAX_FIELD_SIZE octets
• ThisDeviceType.getSerialNumber() ()} shall have fewer than DpwsConstants.MAX_FIELD_SIZE octets

Attention: If those limits are exceeded, the underlying implementation may cut off overflowing characters.

Specified by:

setThisDevice in interface HostingServiceAccess

Parameters:

thisDevice - the ThisModel information to set.

See Also:

• 4.1 Characteristics

setThisModel

public void setThisModel(ThisModelType thisModel)

Description copied from interface: HostingServiceAccess

Updates the ThisModel definition.

According to the DPWS specification, certain information is limited in the number of characters:

• ThisModelType.getManufacturer() ()} shall have fewer than DpwsConstants.MAX_FIELD_SIZE octets
• ThisModelType.getModelName() ()} shall have fewer than DpwsConstants.MAX_FIELD_SIZE octets
• ThisModelType.getModelNumber() ()} ()} shall have fewer than DpwsConstants.MAX_FIELD_SIZE octets
• ThisModelType.getManufacturerUrl() shall have fewer than DpwsConstants.MAX_URI_SIZE octets
• ThisModelType.getModelUrl() ()} shall have fewer than DpwsConstants.MAX_URI_SIZE octets

Attention: If those limits are exceeded, the underlying implementation may cut off overflowing characters.

Specified by:

setThisModel in interface HostingServiceAccess

Parameters:

thisModel - the ThisModel information to set.

See Also:

• 4.1 Characteristics

addHostedService

public void addHostedService(HostedService hostedService)

Description copied from interface: HostingServiceAccess

Adds a hosted service definition.

Attention: there is currently no mechanism that verifies if the hosted service was added before!

Specified by:

addHostedService in interface HostingServiceAccess

Parameters:

hostedService - the hosted service definition to add.