org.ws4d.java.dispatch

Class DeviceServiceRegistry

java.lang.Object

org.ws4d.java.dispatch.DeviceServiceRegistry

public abstract class DeviceServiceRegistry
extends java.lang.Object

Registry class which manages deviceInvokers, serviceInvokers and their references. Many methods of this class register service and service reference listeners.

Method Summary

Modifier and Type	Method and Description
static void	announceDeviceBye(LocalDevice device)
static void	announceDeviceChangedAndBuildUp(LocalDevice device)
static void	announceDeviceRunningAndBuildUp(LocalDevice device)
static boolean	checkAndUpdateAppSequence(EndpointReference ref, AppSequence seq) Returns true if the buffer for the application sequence is up to date.
static ServiceReference	createServiceReference(EndpointReference epr, SecurityKey securityKey, QNameSet portTypes, ConnectionInfo connectionInfo, java.lang.String comManId) Return a service reference for given epr, security key, port types.
static void	decAppSequenceUser() Decreases the app sequence buffer.
static DataStructure	getAllRegisteredDevices()
static DeviceReference	getDeviceReference(DeviceReference oldDevRef, SecurityKey newKey)
static DeviceReference	getDeviceReference(EndpointReference epr, SecurityKey securityKey, java.lang.String comManId) Get device reference of a device location is unknown for given epr and security key.
static DeviceReference	getDeviceReference(EndpointReference epr, SecurityKey securityKey, java.lang.String comManId, boolean doCreate) Returns the device reference to the specified endpoint reference.
static DeviceReference	getDeviceReference(EndpointReference epr, SecurityKey securityKey, XAddressInfoSet addresses, java.lang.String comManId, boolean doCreate) Returns the device reference for the specified endpoint reference, security key and xaddresses.
static DeviceReference	getDeviceReference(EndpointReference epr, XAddressInfoSet addresses, java.lang.String comManId, boolean doCreate) Returns the device reference for the specified endpoint reference and xaddresses.
static DeviceReference	getDeviceReference(HelloData helloData, SecurityKey securityKey, java.lang.String comManId) Get device reference of a remote device if for incoming hello data and security key.
static DeviceReference	getDeviceReference(LocalDevice device, SecurityKey securityKey) Get device reference of a local device and security key.
static LocalDevice	getLocalDevice(EndpointReference epr, SecurityKey securityKey) Looks for local device of given epr and security key.
static DataStructure	getLocalDeviceReferences(SearchParameter search) Looks for local device reference for given search.
static LocalService	getLocalService(Iterator eprInfoSet, SecurityKey securityKey) Looks for local service of given epr and security key.
static DataStructure	getLocalServiceReferences(SearchParameter search) Looks for local service references for given search.
static ServiceReference	getServiceReference(DefaultServiceReference oldServRef, SecurityKey newSecurityKey)
static ServiceReference	getServiceReference(EndpointReference epr, SecurityKey securityKey, java.lang.String comManId, boolean doCreate)
static DeviceReference	getUpdatedDeviceReference(DiscoveryData newData, SecurityKey key, Message msg, ConnectionInfo connectionInfo) Update an matched device reference by new discovery data (e.g.
static ServiceReference	getUpdatedServiceReference(HostedMData hosted, EndpointReference parentDeviceEndpointReference, SecurityKey securityKey, ConnectionInfo connectionInfo, java.lang.String comManId) Looks for an service reference which should be updated.
static void	incAppSequenceUser() Increases the app sequence buffer.
static void	register(DiscoveryBinding binding, CommunicationManager manager) Registers a discovery binding for lifecycle listening.
static void	register(LocalDevice device) Registers a local device.
static void	register(LocalService service) Registers a local service.
static void	setDiscoveryData(LocalDevice device, DiscoveryData discoveryData) Set discovery date for an local device.
static void	tearDown() Stops all available communication manager, devices and services.
static void	unregister(DiscoveryBinding binding, CommunicationManager manager) Unregisters a discovery binding for lifecycle listening.
static void	unregister(LocalDevice device) Unregisters a local device.
static void	unregister(LocalService service) Unregisters a local service.
static void	unregisterDeviceReference(DefaultDeviceReference deviceReference) Removes proxy device reference.

Methods inherited from class java.lang.Object

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

Method Detail

getAllRegisteredDevices

public static DataStructure getAllRegisteredDevices()

tearDown

public static void tearDown()

Stops all available communication manager, devices and services.

getDeviceReference

public static DeviceReference getDeviceReference(HelloData helloData,
                                                 SecurityKey securityKey,
                                                 java.lang.String comManId)

Get device reference of a remote device if for incoming hello data and security key. If no device reference registered for this device, a new one will be created.

Parameters:

helloData - ,combination of incoming hello and communication information.

securityKey - ,security key for device reference.

Returns:

deviceReference, for helloData and key

getDeviceReference

public static DeviceReference getDeviceReference(EndpointReference epr,
                                                 SecurityKey securityKey,
                                                 java.lang.String comManId)

Get device reference of a device location is unknown for given epr and security key. If no device reference registered for this device, a new will be created.

Parameters:

epr - ,Endpoint reference of the device being looked for.

securityKey - ,security key for device reference.

Returns:

deviceReference for epr and key

getDeviceReference

public static DeviceReference getDeviceReference(EndpointReference epr,
                                                 SecurityKey securityKey,
                                                 java.lang.String comManId,
                                                 boolean doCreate)

Returns the device reference to the specified endpoint reference.

Parameters:

epr - , Endpoint reference of the device being looked for.

securityKey - ,security key for device reference.

doCreate - ,If true, reference will be created if not already existing.

Returns:

Device reference being looked for.

getDeviceReference

public static DeviceReference getDeviceReference(EndpointReference epr,
                                                 XAddressInfoSet addresses,
                                                 java.lang.String comManId,
                                                 boolean doCreate)

Returns the device reference for the specified endpoint reference and xaddresses.

Parameters:

epr - ,Endpoint reference of the device being looked for.

doCreate - ,If true, reference will be created if not already existing.

Returns:

Device reference being looked for.

getDeviceReference

public static DeviceReference getDeviceReference(EndpointReference epr,
                                                 SecurityKey securityKey,
                                                 XAddressInfoSet addresses,
                                                 java.lang.String comManId,
                                                 boolean doCreate)

Returns the device reference for the specified endpoint reference, security key and xaddresses.

Parameters:

epr - ,Endpoint reference of the device being looked for.

securityKey - ,security key for device reference.

doCreate - ,If true, reference will be created if not already existing.

Returns:

Device reference being looked for.

getDeviceReference

public static DeviceReference getDeviceReference(DeviceReference oldDevRef,
                                                 SecurityKey newKey)

getDeviceReference

public static DeviceReference getDeviceReference(LocalDevice device,
                                                 SecurityKey securityKey)

Get device reference of a local device and security key. If no device reference registered for this device, a new will be created.

Parameters:

device - ,local device which is being looked for. /**

securityKey - ,security key for device reference.

Returns:

deviceReference for local device and key

createServiceReference

public static ServiceReference createServiceReference(EndpointReference epr,
                                                      SecurityKey securityKey,
                                                      QNameSet portTypes,
                                                      ConnectionInfo connectionInfo,
                                                      java.lang.String comManId)
                                               throws DuplicateServiceReferenceException

Return a service reference for given epr, security key, port types. Used for proxy services. If no service reference is given a new one will be build.

Parameters:

epr - ,endpoint reference of the service reference.

securityKey - ,security key for device reference.

portTypes - ,port types of the service reference.

connectionInfo -

comManId -

Returns:

found service reference or new service reference.

Throws:

DuplicateServiceReferenceException

getUpdatedServiceReference

public static ServiceReference getUpdatedServiceReference(HostedMData hosted,
                                                          EndpointReference parentDeviceEndpointReference,
                                                          SecurityKey securityKey,
                                                          ConnectionInfo connectionInfo,
                                                          java.lang.String comManId)

Looks for an service reference which should be updated. If found some this will be updated else a new service reference will be build.

Parameters:

hosted - ,new hosted data.

parentDeviceEndpointReference - ,endpoint reference of the parent device reference.

securityKey - ,security key for device reference.

connectionInfo -

Returns:

serviceReference for hosted, parent epr ,key and connectionInfo

getUpdatedDeviceReference

public static DeviceReference getUpdatedDeviceReference(DiscoveryData newData,
                                                        SecurityKey key,
                                                        Message msg,
                                                        ConnectionInfo connectionInfo)

Update an matched device reference by new discovery data (e.g. hello).

Parameters:

newData - ,discovery data for update a matching device reference.

key - ,security key for device reference.

msg -

connectionInfo -

Returns:

deviceReference for discovery data, key, msg, connectionInfo

getServiceReference

public static ServiceReference getServiceReference(DefaultServiceReference oldServRef,
                                                   SecurityKey newSecurityKey)

getServiceReference

public static ServiceReference getServiceReference(EndpointReference epr,
                                                   SecurityKey securityKey,
                                                   java.lang.String comManId,
                                                   boolean doCreate)

getLocalDeviceReferences

public static DataStructure getLocalDeviceReferences(SearchParameter search)

Looks for local device reference for given search.

Parameters:

search -

Returns:

data structure with potential matched device references.

getLocalDevice

public static LocalDevice getLocalDevice(EndpointReference epr,
                                         SecurityKey securityKey)
                                  throws AuthorizationException

Looks for local device of given epr and security key.

Parameters:

epr - ,endpoint reference of the local device.

securityKey - ,security key for device reference.

Returns:

local device for epr and key if available, else null

Throws:

AuthorizationException

getLocalService

public static LocalService getLocalService(Iterator eprInfoSet,
                                           SecurityKey securityKey)
                                    throws AuthorizationException

Looks for local service of given epr and security key.

Parameters:

eprInfoSet - ,EprInfoSet of the local service.

securityKey - ,security key for device reference.

Returns:

local service, for eprInfoset and key if available, else null

Throws:

AuthorizationException

getLocalServiceReferences

public static DataStructure getLocalServiceReferences(SearchParameter search)

Looks for local service references for given search.

Parameters:

search -

Returns:

data structure of potential matched service references.

unregisterDeviceReference

public static void unregisterDeviceReference(DefaultDeviceReference deviceReference)

Removes proxy device reference.

Parameters:

deviceReference - proxy device reference to remove.

register

public static void register(LocalDevice device)

Registers a local device.

Parameters:

device - ,local device to register.

unregister

public static void unregister(LocalDevice device)

Unregisters a local device.

Parameters:

device - ,local device to unregister.

register

public static void register(LocalService service)

Registers a local service.

Parameters:

service - ,local service to register.

unregister

public static void unregister(LocalService service)

Unregisters a local service.

Parameters:

service - ,local service to unregister.

register

public static void register(DiscoveryBinding binding,
                            CommunicationManager manager)

Registers a discovery binding for lifecycle listening.

Parameters:

binding -

manager -

unregister

public static void unregister(DiscoveryBinding binding,
                              CommunicationManager manager)

Unregisters a discovery binding for lifecycle listening.

Parameters:

binding -

manager -

setDiscoveryData

public static void setDiscoveryData(LocalDevice device,
                                    DiscoveryData discoveryData)

Set discovery date for an local device.

Parameters:

device - ,local device where discovery data should be set.

discoveryData - ,discovery which should be set.

announceDeviceChangedAndBuildUp

public static void announceDeviceChangedAndBuildUp(LocalDevice device)

announceDeviceRunningAndBuildUp

public static void announceDeviceRunningAndBuildUp(LocalDevice device)

announceDeviceBye

public static void announceDeviceBye(LocalDevice device)

checkAndUpdateAppSequence

public static boolean checkAndUpdateAppSequence(EndpointReference ref,
                                                AppSequence seq)

Returns true if the buffer for the application sequence is up to date.

Returns:

true ,if appsequence is up to date.

incAppSequenceUser

public static void incAppSequenceUser()

Increases the app sequence buffer.

decAppSequenceUser

public static void decAppSequenceUser()

Decreases the app sequence buffer.