org.ws4d.java.communication

Interface CommunicationManager

All Known Subinterfaces:

CommunicationManagerInternal

All Known Implementing Classes:

DPWSCommunicationManager

public interface CommunicationManager

The * NEW * communication manager interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID_NULL

Method Summary

Modifier and Type	Method and Description
QNameSet	adaptDeviceTypes(QNameSet qnames) CommunicationManager specific adaptation of device-types.
QNameSet	adaptServiceTypes(QNameSet qnames) CommunicationManager specific adaptation of service-types.
java.lang.String	checkIfAddressIsAnyLocalThenInterface(java.lang.String from, ConnectionInfo connectionInfo)
boolean	containsAllDeviceTypes(QNameSet searchTypes, QNameSet types)
boolean	containsAllSearchScopes(ScopeSet searchScopes, ScopeSet deviceScopes)
boolean	containsAllServiceTypes(QNameSet searchTypes, QNameSet types)
FaultMessage	createActionNotSupportedFault(Message request, java.lang.String actionString, ProtocolInfo protocolInfo) Creates an "ActionNotSupported" FaultMessage for the given request Message and ProtocolInfo.
FaultMessage	createAuthorizationFault(Message request) Creates an "Authorization" FaultMessage for the given request Message.
EndpointReference	createDynamicEndpointReference()
FaultMessage	createEndpointUnavailableFault(Message request) Creates an "EndpointUnavailable" FaultMessage for the given request Message.
EventingException	createEventingException(int type, java.lang.String reason) Creates an EventingException for the given type and reason.
FaultMessage	createInvalidAddressingHeaderFault(Message request, LocalizedString reason, ProtocolInfo protocolInfo) Creates an "InvalidAddressingHeader" FaultMessage for the given request Message, LocalizedString and ProtocolInfo .
InvocationException	createInvocationException(Fault fault, boolean sender, QName subcode, DataStructure reason, ParameterValue parameterValue) Creates an InvocationException for the given Fault, sender, QName, reason and ParameterValue
InvocationException	createInvocationExceptionSOAPFault(boolean sender, QName subcode, DataStructure reason, ParameterValue parameterValue) Creates an InvocationException for the given sender, QName, reason and ParameterValue
FaultMessage	createInvocationFault(InvocationException inEx, InvokeMessage invokeRequest, ProtocolInfo protocolInfo) Creates an "Invocation" FaultMessage for the given InvocationException , InvokeMessage and ProtocolInfo.
FaultMessage	createMessageAddressingHeaderRequiredFault() Creates an "MessageAddressingHeaderRequirede" FaultMessage.
ProtocolInfo	createProtocolInfo() Returns the an instance of ProtocolInfo for this CommunicationManager.
ProtocolInfo	createProtocolInfo(ProtocolVersion version) Creates an instance of ProtocolInfo according to the given version information.
SOAPException	createSubscriptionFault(int faultType, Message msg, LocalizedString reason, ProtocolInfo protocolInfo, boolean sender) Creates an "SubscriptionFault" SOAPException for the given faultType, Message, LocalizedString, ProtocolInfo and sender.
AddressFilter	getAddressFilter() Address filter
Iterator	getAllAvailableDiscoveryDomains() Returns an iterator over all available discovery domains from the underlying communication layer.
int	getAllAvailableDiscoveryDomainsSize() Returns the size of all available discovery domains from the underlying communication layer.
AutoBindingFactory	getAutoBindingFactory() Returns the AutoBindingFactory for the specified communicationManager to generate autobindings.
DataStructure	getAvailableOutgoingDiscoveryInfos(boolean includeXAddressInHello, CredentialInfo localCredentialInfo) Returns all available OutgoingDiscoveryInfos for the given combination of includeXAddressInHello and localCredentialInfo.
Iterator	getChildren(DeviceReference devRef, boolean doDiscovery) Returns the embedded device references, if any exist.
CommunicationBinding	getCommunicationBinding(DiscoveryBinding binding, java.lang.String path) Creates and returns the CommunicationBinding for the given DiscoveryBinding and path.
java.lang.String	getCommunicationManagerId() Returns the unique identifier of this communication manager's technology (e.g.
QName	getDeviceType(ProtocolVersion pinfo)
QNameSet	getDeviceTypes(LocalDevice device)
DiscoveryBinding	getDiscoveryBinding(ConnectionInfo connectionInfo) Returns a DiscoveryBinding for the given ConnectionInfo
DiscoveryBinding	getDiscoveryBinding(OutgoingDiscoveryInfo outgoingDiscoveryInfo) Returns a DiscoveryBinding for the given OutgoingDiscoveryInfo.
DataStructure	getDiscoveryBindings(CommunicationBinding binding) Returns all DiscoveryBindings for the given CommunicationBinding.
MetadataValidator	getMetadataValidator()
java.lang.Object[]	getMulticastAddressAndPortForDiscoveryBinding(DiscoveryDomain discoveryDomain) Returns the multicast-address at position 0 and the multicast-port (as Integer) at positon 1.
java.lang.Object[]	getMulticastAddressAndPortForOutgoingDiscoveryInfo(DiscoveryDomain discoveryDomain) Returns the multicast-address at position 0 and the multicast-port (as Integer) at positon 1.
OutgoingDiscoveryInfo	getOutgoingDiscoveryInfo(ConnectionInfo connectionInfo) Returns a OutgoingDiscoveryInfo for given ConnectionInfo.
OutgoingDiscoveryInfo	getOutgoingDiscoveryInfo(DiscoveryBinding discoveryBinding, boolean includeXAddressInHello, CredentialInfo localCredentialInfo) Returns all generated OutgoingDiscoveryInfos for the given combination of DiscoveryBinding, includeXAddressInHello and CredentialInfo.
DataStructure	getOutgoingDiscoveryInfos(CommunicationBinding binding, boolean includeXAddressInHello, CredentialInfo localCredentialInfo) Returns all generated OutgoingDiscoveryInfos for the given combination of CommunicationBinding, includeXAddressInHello and CredentialInfo.
long	getRandomApplicationDelay(ProtocolVersion version) Returns the random application delay for given ProtocolVersion.
ResourceLoader	getResourceAsStream(URI location, CredentialInfo credentialInfo) Returns an input stream which allows to read a resource from the given location.
HashSet	getSupportedVersions() Returns a set of supported versions by this CommunicationManager.
void	init() This method will be invoked by the framework during the start up phase.
boolean	isTransportAddress(URI uri) Returns true if the uri represents a transport address.
DescriptionParser	newDescriptionParser()
DescriptionSerializer	newDescriptionSerializer()
void	registerDevice(CommunicationBinding binding, IncomingMessageListener listener, LocalDevice device) Registers the messageListener for receiving incoming messages.
void	registerDiscovery(int[] messageTypes, DiscoveryBinding binding, IncomingMessageListener listener, LocalDevice device) Registers the messageListener for receiving incoming messages of the specified messageTypes at the given binding address.
URI	registerResource(Resource resource, CommunicationBinding binding, java.lang.String resourcePath, AuthorizationManager authMan) Deploys the given resource so that it can be accessed over the technology that this communication manager instance represents.
void	registerService(int[] messageTypes, CommunicationBinding binding, IncomingMessageListener listener, LocalService service) Registers the messageListener for receiving incoming messages of the specified messageTypes at the given binding address.
void	send(Message message, ProtocolInfo protocolInfo, DataStructure discoveryInfos, ResponseCallback callback) Sends the message as a asynchronous request through the specified discoveryInfos; any responses (if present) including faults and timeouts will be delivered to the given callback.
void	send(Message message, XAddressInfo targetXAddrInfo, CredentialInfo credentialInfo) Sends message to an explicit endpoint and is not waiting for response.
void	send(Message message, XAddressInfo targetXAdrInfo, CredentialInfo credentialInfo, ResponseCallback callback) Sends message as synchronous request / response.
void	setAddressFilter(AddressFilter filter) TODO will be removed in future
boolean	supportsAddressingNamespace(java.lang.String namespace, java.lang.String name, ConnectionInfo ci) Checks if the given namespace would be supported.
boolean	supportsEventingFilterDialect(URI dialect, ProtocolInfo protocolInfo) Checks if the dialect shall supported.
void	unregisterDevice(CommunicationBinding binding, LocalDevice device) Destroys a previously made registration for the given binding.
boolean	unregisterDiscovery(int[] messageTypes, DiscoveryBinding binding, IncomingMessageListener listener, LocalDevice device) Destroys a previously made #registerDiscovery(int[], DiscoveryBinding, IncomingMessageListener) registration for the given messageTypes, binding and listener.
void	unregisterResource(URI deployAddress, CommunicationBinding binding) Removes the previously deployed resource at the given deployAddress from this communication manager.
void	unregisterService(int[] messageTypes, CommunicationBinding binding, LocalService service) Destroys a previously made registerService(int[], CommunicationBinding, IncomingMessageListener, LocalService) registration for the given messageTypes and binding.
int	validateMessage(SignableMessage message, ConnectionInfo connectionInfo, CredentialInfo credentialInfo, java.lang.String defaultKeyId) Validates the given SignableMessage with the given ConnectionInfo, CredentialInfo and defaultKeyId.

Field Detail

ID_NULL

static final java.lang.String ID_NULL

Method Detail

init

void init()

This method will be invoked by the framework during the start up phase.

getCommunicationManagerId

java.lang.String getCommunicationManagerId()

Returns the unique identifier of this communication manager's technology (e.g. DPWS, UPNP, BT, etc.).

Returns:

the unique ID of this communication manager

registerDevice

void registerDevice(CommunicationBinding binding,
                    IncomingMessageListener listener,
                    LocalDevice device)
             throws java.io.IOException,
                    WS4DIllegalStateException

Registers the messageListener for receiving incoming messages.

Parameters:

binding - the binding to register to

listener - the callback to deliver incoming desired messages to

Throws:

java.io.IOException - in case registration failed for some reason, e.g. an address being already in use, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

registerService

void registerService(int[] messageTypes,
                     CommunicationBinding binding,
                     IncomingMessageListener listener,
                     LocalService service)
              throws java.io.IOException,
                     WS4DIllegalStateException

Registers the messageListener for receiving incoming messages of the specified messageTypes at the given binding address. See MessageConstants for a list of supported message types.

Parameters:

messageTypes - determines which message types to register to

binding - the binding to register to

listener - the callback to deliver incoming desired messages to

service - TODO

Throws:

java.io.IOException - in case registration failed for some reason, e.g. an address being already in use, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

registerDiscovery

void registerDiscovery(int[] messageTypes,
                       DiscoveryBinding binding,
                       IncomingMessageListener listener,
                       LocalDevice device)
                throws java.io.IOException,
                       WS4DIllegalStateException

Registers the messageListener for receiving incoming messages of the specified messageTypes at the given binding address. See MessageConstants for a list of supported message types.

Parameters:

messageTypes - determines which message types to register to

binding - the binding to register to

listener - the callback to deliver incoming desired messages to * @param

device - the device or null.

Throws:

java.io.IOException - in case registration failed for some reason, e.g. an address being already in use, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

unregisterDevice

void unregisterDevice(CommunicationBinding binding,
                      LocalDevice device)
               throws java.io.IOException,
                      WS4DIllegalStateException

Destroys a previously made registration for the given binding.

Parameters:

binding - the binding to remove

Throws:

java.io.IOException - in case removing the registration failed for some reason, e.g. this binding was not already registered, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

unregisterService

void unregisterService(int[] messageTypes,
                       CommunicationBinding binding,
                       LocalService service)
                throws java.io.IOException,
                       WS4DIllegalStateException

Destroys a previously made registerService(int[], CommunicationBinding, IncomingMessageListener, LocalService) registration for the given messageTypes and binding.

Parameters:

messageTypes - determines which message types to remove registration from

binding - the binding to remove

Throws:

java.io.IOException - in case removing the registration failed for some reason, e.g. this binding was not already registered, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

unregisterDiscovery

boolean unregisterDiscovery(int[] messageTypes,
                            DiscoveryBinding binding,
                            IncomingMessageListener listener,
                            LocalDevice device)
                     throws java.io.IOException,
                            WS4DIllegalStateException

Destroys a previously made #registerDiscovery(int[], DiscoveryBinding, IncomingMessageListener) registration for the given messageTypes, binding and listener.

Parameters:

messageTypes - determines which message types to remove registration from

binding - the binding to remove

listener - the callback which was previously registered

device - the device or null.

Returns:

true if the listener for the DiscoveryDomain of the DiscoveryBinding was actually closed

Throws:

java.io.IOException - in case removing the registration failed for some reason, e.g. this binding was not already registered, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

send

void send(Message message,
          ProtocolInfo protocolInfo,
          DataStructure discoveryInfos,
          ResponseCallback callback)
   throws WS4DIllegalStateException

Sends the message as a asynchronous request through the specified discoveryInfos; any responses (if present) including faults and timeouts will be delivered to the given callback.

The argument discoveryInfos has a certain meaning only when sending multicast/broadcast messages; this currently applies to HelloMessages, ByeMessages, ProbeMessages and ResolveMessages. In this case, it specifies the concrete transport technology and optionally, some technology- or protocol-specific interfaces (aka. "discoveryInfos") over which to send the multicast message. In the case of DPWS, where multicast messages are sent by means of SOAP-over-UDP, the value of this argument could depict a certain network interface (e.g. eth0, pcn0, etc.) or a specific local IP address. This should then be used to send the multicast message. For further information regarding the outgoing interface of multicast messages when using IP multicast, see RFC 1112.

In the concrete case when message is one of HelloMessage, ByeMessage or SubscriptionEndMessage, the value of callback is ignored. In any other case it is expected to have a non-null value.

Parameters:

message - the request message to send

protocolInfo - information about protocol details

discoveryInfos - the outgoing discovery info (the protocol domain over which to send the message)

callback - where to deliver responses to the message

Throws:

WS4DIllegalStateException - if this communication manager has already been stopped

send

void send(Message message,
          XAddressInfo targetXAdrInfo,
          CredentialInfo credentialInfo,
          ResponseCallback callback)
   throws WS4DIllegalStateException

Sends message as synchronous request / response. For secure communication CredentialInfo is needed. For this communication a callback for the response is needed.

Parameters:

message - message the request message to send

targetXAdrInfo - target address for the communication

credentialInfo - security information for secure communication

callback - callback where to deliver responses to the message

Throws:

WS4DIllegalStateException

send

void send(Message message,
          XAddressInfo targetXAddrInfo,
          CredentialInfo credentialInfo)
   throws WS4DIllegalStateException

Sends message to an explicit endpoint and is not waiting for response. For secure communication CredentialInfo is needed.

Parameters:

message - message message the request message to send

targetXAddrInfo - target address for the communication

credentialInfo - security information for secure communication

Throws:

WS4DIllegalStateException

registerResource

URI registerResource(Resource resource,
                     CommunicationBinding binding,
                     java.lang.String resourcePath,
                     AuthorizationManager authMan)
              throws java.io.IOException,
                     WS4DIllegalStateException

Deploys the given resource so that it can be accessed over the technology that this communication manager instance represents. The resource is made available over the addressing information provided by the specified binding and additional resource-specific addressing information found in resourcePath. Returns an URI depicting the actual address the resource is bound to.

Parameters:

resource - the resource to deploy

binding - a binding over which to make the resource available

resourcePath - additional addressing-related information for use when binding the resource

Returns:

actual address the resource is bound to

Throws:

java.io.IOException - in case binding the resource failed for some reason, e.g. an address being already in use, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

unregisterResource

void unregisterResource(URI deployAddress,
                        CommunicationBinding binding)
                 throws java.io.IOException,
                        WS4DIllegalStateException

Removes the previously deployed resource at the given deployAddress from this communication manager.

Parameters:

deployAddress - the addressing at which the resource previously was registerResource(Resource, CommunicationBinding, String, AuthorizationManager)

binding -

Throws:

java.io.IOException - in case removing the resource failed for some reason, e.g. the resource was not previously deployed, etc.

WS4DIllegalStateException - if this communication manager has already been stopped

getResourceAsStream

ResourceLoader getResourceAsStream(URI location,
                                   CredentialInfo credentialInfo)
                            throws java.io.IOException

Returns an input stream which allows to read a resource from the given location.

Parameters:

location - the location of the resource (e.g. http://example.org/test.wsdl).

Returns:

an input stream for the given resource.

Throws:

java.io.IOException

isTransportAddress

boolean isTransportAddress(URI uri)

Returns true if the uri represents a transport address.

Returns:

true if the uri represents a transport address.

getAutoBindingFactory

AutoBindingFactory getAutoBindingFactory()

Returns the AutoBindingFactory for the specified communicationManager to generate autobindings.

Returns:

autoBindingFactory

getAllAvailableDiscoveryDomains

Iterator getAllAvailableDiscoveryDomains()

Returns an iterator over all available discovery domains from the underlying communication layer.

Returns:

iterator over all discovery domains

getAllAvailableDiscoveryDomainsSize

int getAllAvailableDiscoveryDomainsSize()

Returns the size of all available discovery domains from the underlying communication layer.

Returns:

size of discovery domains

getAvailableOutgoingDiscoveryInfos

DataStructure getAvailableOutgoingDiscoveryInfos(boolean includeXAddressInHello,
                                                 CredentialInfo localCredentialInfo)

Returns all available OutgoingDiscoveryInfos for the given combination of includeXAddressInHello and localCredentialInfo.

Parameters:

includeXAddressInHello -

localCredentialInfo -

Returns:

dataStructure with all available OutgoingDiscoveryInfos.

getDiscoveryBinding

DiscoveryBinding getDiscoveryBinding(OutgoingDiscoveryInfo outgoingDiscoveryInfo)
                              throws java.io.IOException

Returns a DiscoveryBinding for the given OutgoingDiscoveryInfo.

Parameters:

outgoingDiscoveryInfo -

Returns:

discoverysBinding, generated out of the OutgoingDiscoveryInfo

Throws:

java.io.IOException

getDiscoveryBindings

DataStructure getDiscoveryBindings(CommunicationBinding binding)

Returns all DiscoveryBindings for the given CommunicationBinding.

Parameters:

binding -

Returns:

dataStructure with all generated DiscoveryBinding.

getCommunicationBinding

CommunicationBinding getCommunicationBinding(DiscoveryBinding binding,
                                             java.lang.String path)

Creates and returns the CommunicationBinding for the given DiscoveryBinding and path.

Parameters:

binding -

path -

Returns:

the communicationBinding for given discoveryBinding and path

getOutgoingDiscoveryInfo

OutgoingDiscoveryInfo getOutgoingDiscoveryInfo(ConnectionInfo connectionInfo)

Returns a OutgoingDiscoveryInfo for given ConnectionInfo.

Parameters:

connectionInfo -

Returns:

outgoing discovery info for given connection info

getOutgoingDiscoveryInfos

DataStructure getOutgoingDiscoveryInfos(CommunicationBinding binding,
                                        boolean includeXAddressInHello,
                                        CredentialInfo localCredentialInfo)

Returns all generated OutgoingDiscoveryInfos for the given combination of CommunicationBinding, includeXAddressInHello and CredentialInfo.

Parameters:

binding -

includeXAddressInHello -

localCredentialInfo -

Returns:

dataStructure with all generated OutgoingDiscoveryInfo

getOutgoingDiscoveryInfo

OutgoingDiscoveryInfo getOutgoingDiscoveryInfo(DiscoveryBinding discoveryBinding,
                                               boolean includeXAddressInHello,
                                               CredentialInfo localCredentialInfo)

Returns all generated OutgoingDiscoveryInfos for the given combination of DiscoveryBinding, includeXAddressInHello and CredentialInfo.

Parameters:

discoveryBinding -

includeXAddressInHello -

localCredentialInfo -

Returns:

dataStructure with all generated OutgoingDiscoveryInfo

getMulticastAddressAndPortForOutgoingDiscoveryInfo

java.lang.Object[] getMulticastAddressAndPortForOutgoingDiscoveryInfo(DiscoveryDomain discoveryDomain)

Returns the multicast-address at position 0 and the multicast-port (as Integer) at positon 1.

Returns:

getMulticastAddressAndPortForDiscoveryBinding

java.lang.Object[] getMulticastAddressAndPortForDiscoveryBinding(DiscoveryDomain discoveryDomain)

Returns the multicast-address at position 0 and the multicast-port (as Integer) at positon 1.

Returns:

getDiscoveryBinding

DiscoveryBinding getDiscoveryBinding(ConnectionInfo connectionInfo)

Returns a DiscoveryBinding for the given ConnectionInfo

Parameters:

connectionInfo -

Returns:

discoverybindin, generated out of the connection.

createProtocolInfo

ProtocolInfo createProtocolInfo()

Returns the an instance of ProtocolInfo for this CommunicationManager.

Returns:

the protocol info.

createProtocolInfo

ProtocolInfo createProtocolInfo(ProtocolVersion version)

Creates an instance of ProtocolInfo according to the given version information.

Parameters:

version - the version the protocol info should be created for.

Returns:

the protocol info for the given version.

getSupportedVersions

HashSet getSupportedVersions()

Returns a set of supported versions by this CommunicationManager.

This should be a set containing ProtocolVersion objects with the version number.

Returns:

a set of supported versions.

getRandomApplicationDelay

long getRandomApplicationDelay(ProtocolVersion version)

Returns the random application delay for given ProtocolVersion.

Parameters:

version -

Returns:

random application delay as long.

supportsAddressingNamespace

boolean supportsAddressingNamespace(java.lang.String namespace,
                                    java.lang.String name,
                                    ConnectionInfo ci)
                             throws VersionMismatchException

Checks if the given namespace would be supported.

Parameters:

namespace -

name -

ci -

Returns:

true if supports namespace, false if not.

Throws:

VersionMismatchException

getDeviceTypes

QNameSet getDeviceTypes(LocalDevice device)

getDeviceType

QName getDeviceType(ProtocolVersion pinfo)

createActionNotSupportedFault

FaultMessage createActionNotSupportedFault(Message request,
                                           java.lang.String actionString,
                                           ProtocolInfo protocolInfo)

Creates an "ActionNotSupported" FaultMessage for the given request Message and ProtocolInfo.

Parameters:

request -

protocolInfo -

Returns:

faultMessage

createEndpointUnavailableFault

FaultMessage createEndpointUnavailableFault(Message request)

Creates an "EndpointUnavailable" FaultMessage for the given request Message.

Parameters:

request -

Returns:

faultMessage

createMessageAddressingHeaderRequiredFault

FaultMessage createMessageAddressingHeaderRequiredFault()

Creates an "MessageAddressingHeaderRequirede" FaultMessage.

Returns:

faultMessage

createAuthorizationFault

FaultMessage createAuthorizationFault(Message request)

Creates an "Authorization" FaultMessage for the given request Message.

Parameters:

request -

Returns:

faultMessage

createInvocationFault

FaultMessage createInvocationFault(InvocationException inEx,
                                   InvokeMessage invokeRequest,
                                   ProtocolInfo protocolInfo)

Creates an "Invocation" FaultMessage for the given InvocationException , InvokeMessage and ProtocolInfo.

Parameters:

inEx -

invokeRequest -

protocolInfo -

Returns:

faultMessage

createInvalidAddressingHeaderFault

FaultMessage createInvalidAddressingHeaderFault(Message request,
                                                LocalizedString reason,
                                                ProtocolInfo protocolInfo)

Creates an "InvalidAddressingHeader" FaultMessage for the given request Message, LocalizedString and ProtocolInfo .

Parameters:

request -

reason -

protocolInfo -

Returns:

faultMessage

createSubscriptionFault

SOAPException createSubscriptionFault(int faultType,
                                      Message msg,
                                      LocalizedString reason,
                                      ProtocolInfo protocolInfo,
                                      boolean sender)

Creates an "SubscriptionFault" SOAPException for the given faultType, Message, LocalizedString, ProtocolInfo and sender.

Parameters:

faultType -

msg -

reason -

protocolInfo -

sender -

Returns:

faultMessage

createEventingException

EventingException createEventingException(int type,
                                          java.lang.String reason)

Creates an EventingException for the given type and reason.

Parameters:

type -

reason -

Returns:

eventingException

createInvocationException

InvocationException createInvocationException(Fault fault,
                                              boolean sender,
                                              QName subcode,
                                              DataStructure reason,
                                              ParameterValue parameterValue)

Creates an InvocationException for the given Fault, sender, QName, reason and ParameterValue

Parameters:

fault -

sender -

subcode -

reason -

parameterValue -

Returns:

invocationException

createInvocationExceptionSOAPFault

InvocationException createInvocationExceptionSOAPFault(boolean sender,
                                                       QName subcode,
                                                       DataStructure reason,
                                                       ParameterValue parameterValue)

Creates an InvocationException for the given sender, QName, reason and ParameterValue

Parameters:

sender -

subcode -

reason -

parameterValue -

Returns:

invocationException

supportsEventingFilterDialect

boolean supportsEventingFilterDialect(URI dialect,
                                      ProtocolInfo protocolInfo)

Checks if the dialect shall supported.

Parameters:

dialect -

protocolInfo -

Returns:

true if supports dialect, false if not.

validateMessage

int validateMessage(SignableMessage message,
                    ConnectionInfo connectionInfo,
                    CredentialInfo credentialInfo,
                    java.lang.String defaultKeyId)

Validates the given SignableMessage with the given ConnectionInfo, CredentialInfo and defaultKeyId.

Parameters:

message -

connectionInfo -

credentialInfo -

defaultKeyId -

Returns:

id of validation

getAddressFilter

AddressFilter getAddressFilter()

Address filter

setAddressFilter

void setAddressFilter(AddressFilter filter)

TODO will be removed in future

checkIfAddressIsAnyLocalThenInterface

java.lang.String checkIfAddressIsAnyLocalThenInterface(java.lang.String from,
                                                       ConnectionInfo connectionInfo)

newDescriptionParser

DescriptionParser newDescriptionParser()

Returns:

a new description parser.

newDescriptionSerializer

DescriptionSerializer newDescriptionSerializer()

Returns:

a new description serializer.

containsAllDeviceTypes

boolean containsAllDeviceTypes(QNameSet searchTypes,
                               QNameSet types)

Parameters:

searchTypes -

types -

Returns:

containsAllServiceTypes

boolean containsAllServiceTypes(QNameSet searchTypes,
                                QNameSet types)

Parameters:

searchTypes -

types -

Returns:

containsAllSearchScopes

boolean containsAllSearchScopes(ScopeSet searchScopes,
                                ScopeSet deviceScopes)

Parameters:

searchScopes -

deviceScopes -

Returns:

adaptServiceTypes

QNameSet adaptServiceTypes(QNameSet qnames)
                    throws java.lang.IllegalArgumentException

CommunicationManager specific adaptation of service-types.

Parameters:

qnames -

Returns:

Throws:

java.lang.IllegalArgumentException

adaptDeviceTypes

QNameSet adaptDeviceTypes(QNameSet qnames)
                   throws java.lang.IllegalArgumentException

CommunicationManager specific adaptation of device-types.

Parameters:

qnames -

Returns:

Throws:

java.lang.IllegalArgumentException

createDynamicEndpointReference

EndpointReference createDynamicEndpointReference()

getMetadataValidator

MetadataValidator getMetadataValidator()

getChildren

Iterator getChildren(DeviceReference devRef,
                     boolean doDiscovery)
              throws CommunicationException

Returns the embedded device references, if any exist. Embedded devices are supported only by certain underlying technologies. Invoking this methods on a device reference of a technology like DPWS, where embedded devices do not exist, will always yield a return value of null. Getting information about the device hierarchy in some technologies involves additional communication over the network. Before this communication has taken place, the embed information returned by this method should be seen as preliminary.

Parameters:

devRef - the device reference for which the children should be fetched

doDiscovery - should be true if additional network communication is acceptable. This method will block until the information has been obtained.

Returns:

An iterator over a data structure containing the device references in the next lower level

Throws:

CommunicationException - Can only be thrown when doDiscovery is set to true