org.ws4d.java.communication

Class DPWSCommunicationManager

java.lang.Object

org.ws4d.java.communication.DPWSCommunicationManager

All Implemented Interfaces:

CommunicationManager, CommunicationManagerInternal

public class DPWSCommunicationManager
extends java.lang.Object
implements CommunicationManagerInternal

Field Summary

Fields

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

Fields inherited from interface org.ws4d.java.communication.CommunicationManager

ID_NULL

Constructor Summary

Constructors

Constructor and Description
DPWSCommunicationManager() Public default constructor, needed for reflective instance creation ( Class.forName(...) ).

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.
protected void	checkAndSendTCPMessage(Message message, ResponseCallback callback, XAddressInfo targetXAddrInfo, CredentialInfo credentialInfo)
java.lang.String	checkIfAddressIsAnyLocalThenInterface(java.lang.String addr, 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) Faults
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) Exceptions
FaultMessage	createGenericFault(Message request, java.lang.String reason)
FaultMessage	createGenericFault(Message request, java.lang.String reason, AttributedURI relatesTo)
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 params) Creates an InvocationException for the given Fault, sender, QName, reason and ParameterValue
InvocationException	createInvocationExceptionSOAPFault(boolean sender, QName subcode, DataStructure reason, ParameterValue params) 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 version)
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.
static DPWSConstantsHelper	getHelper(ConnectionInfo connectionInfo)
static DPWSConstantsHelper	getHelper(ProtocolVersion dpwsVersion)
static HashSet	getMessageIDsForGetMetadataMapping()
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 dpwsVersion) Returns the random application delay for given ProtocolVersion.
static Set	getRegisterForGetMetadata()
ResourceLoader	getResourceAsStream(URI location, CredentialInfo credentialInfo) Returns an input stream which allows to read a resource from the given location.
protected SOAPoverUDPServer	getSOAPoverUDPServer(IPDiscoveryBinding binding, boolean create)
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.
static boolean	isMessageComplyingWithSecurityRequirements(SignableMessage message, ConnectionInfo connectionInfo, java.lang.String defaultKeyId)
boolean	isTransportAddress(URI uri) Returns true if the uri represents a HTTP, HTTPS or SOAP-over-UDP transport address.
void	kill() Important: This method may only be called from the CommunicationManagerRegistry! Stops this communication manager immediately, closes all connections and frees any used resources without waiting for.
DescriptionParser	newDescriptionParser()
DescriptionSerializer	newDescriptionSerializer()
void	registerDevice(CommunicationBinding binding, IncomingMessageListener listener, LocalDevice device) Registers a device to receive (TCP) messages on a specified socket.
void	registerDiscovery(int[] messageTypes, DiscoveryBinding binding, IncomingMessageListener listener, LocalDevice device) Registers the framework to receive (UDP) discovery messages on a specified socket.
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 a service to receive (TCP) messages on a specified socket.
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 targetXAddrInfo, CredentialInfo credentialInfo, ResponseCallback callback) Sends message as synchronous request / response.
long	serializeMessageWithAttachments(Message message, byte[] mimeBoundary, List attachments, java.io.ByteArrayOutputStream[] buffer, ConnectionInfo ci, AttributedURI optionalMessageId)
void	serializeMessageWithAttachments(Message message, byte[] mimeBoundary, List attachments, java.io.OutputStream out, ConnectionInfo ci, AttributedURI optionalMessageId)
void	setAddressFilter(AddressFilter filter) TODO will be removed in future
void	start() Important: This method may only be called from the CommunicationManagerRegistry! Starts this communication manager instance.
void	stop() Important: This method may only be called from the CommunicationManagerRegistry! Stops this communication manager as soon as possible, closes all connections and frees any used resources.
boolean	supportsAddressingNamespace(java.lang.String namespace, java.lang.String name, ConnectionInfo ci) Checks if the given namespace would be supported.
boolean	supportsDiscoveryNamespace(java.lang.String namespace, java.lang.String name, ConnectionInfo ci)
boolean	supportsEventingFilterDialect(URI dialect, ProtocolInfo protocolInfo) UTIL
boolean	supportsEventingNamespace(java.lang.String namespace, java.lang.String name, ConnectionInfo ci)
void	unregisterDevice(CommunicationBinding binding, LocalDevice device) Unregisters a device to stop receiving (TCP) messages on a specified socket.
boolean	unregisterDiscovery(int[] messageTypes, DiscoveryBinding binding, IncomingMessageListener listener, LocalDevice device) Unregisters the framework to stop receiving (UDP) discovery messages on a specified socket.
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) Unregisters a service to stop receiving (TCP) messages on a specified socket.
int	validateMessage(SignableMessage message, ConnectionInfo connectionInfo, CredentialInfo credentialInfo, java.lang.String defaultKeyId) Validates the given SignableMessage with the given ConnectionInfo, CredentialInfo and defaultKeyId.

Methods inherited from class java.lang.Object

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

Field Detail

COMMUNICATION_MANAGER_ID

public static final java.lang.String COMMUNICATION_MANAGER_ID

See Also:

Constant Field Values

Constructor Detail

DPWSCommunicationManager

public DPWSCommunicationManager()

Public default constructor, needed for reflective instance creation ( Class.forName(...) ).

Method Detail

getMessageIDsForGetMetadataMapping

public static HashSet getMessageIDsForGetMetadataMapping()

getHelper

public static DPWSConstantsHelper getHelper(ConnectionInfo connectionInfo)

getHelper

public static DPWSConstantsHelper getHelper(ProtocolVersion dpwsVersion)

isMessageComplyingWithSecurityRequirements

public static boolean isMessageComplyingWithSecurityRequirements(SignableMessage message,
                                                                 ConnectionInfo connectionInfo,
                                                                 java.lang.String defaultKeyId)

getRegisterForGetMetadata

public static Set getRegisterForGetMetadata()

init

public void init()

Description copied from interface: CommunicationManager

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

Specified by:

init in interface CommunicationManager

getCommunicationManagerId

public java.lang.String getCommunicationManagerId()

Description copied from interface: CommunicationManager

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

Specified by:

getCommunicationManagerId in interface CommunicationManager

Returns:

the unique ID of this communication manager

start

public void start()
           throws java.io.IOException

Description copied from interface: CommunicationManagerInternal

Important: This method may only be called from the CommunicationManagerRegistry! Starts this communication manager instance. This method executes any needed initialization steps so that further calls to other methods such as #registerDevice(CommunicationBinding, IncomingMessageListener) , CommunicationManager.send(Message, ProtocolInfo, DataStructure, ResponseCallback), etc. can operate correctly.

If this communication manager has already been started, this method must not do anything else other than quickly return.

Specified by:

start in interface CommunicationManagerInternal

Throws:

java.io.IOException - in case initializing communication failed for some reason; the caller should assume that this communication manager instance is not usable

kill

public void kill()

Description copied from interface: CommunicationManagerInternal

Important: This method may only be called from the CommunicationManagerRegistry! Stops this communication manager immediately, closes all connections and frees any used resources without waiting for. Any further interactions with this instance like #registerDevice(CommunicationBinding, IncomingMessageListener) registering listeners or CommunicationManager.send(Message, ProtocolInfo, DataStructure, ResponseCallback) sending messages will result in WS4DIllegalStateException illegal state exceptions.

WARNING! This method causes the communication manager to loose all of its current state! That is, reactivating the communication manager again after this method has been called will result in having no #registerDevice(CommunicationBinding, IncomingMessageListener), CommunicationManager.registerService(int[], CommunicationBinding, IncomingMessageListener, LocalService) or #registerDiscovery(int[], DiscoveryBinding, IncomingMessageListener) registrations for incoming messages.

If this communication manager has already been stopped, this method must not do anything else other than quickly return

Specified by:

kill in interface CommunicationManagerInternal

stop

public void stop()

Description copied from interface: CommunicationManagerInternal

Important: This method may only be called from the CommunicationManagerRegistry! Stops this communication manager as soon as possible, closes all connections and frees any used resources. Any further interactions with this instance like #registerDevice(CommunicationBinding, IncomingMessageListener) registering listeners or CommunicationManager.send(Message, ProtocolInfo, DataStructure, ResponseCallback) sending messages will result in WS4DIllegalStateException illegal state exceptions.

If it is necessary to stop the communication manager immediately the CommunicationManagerInternal.kill() method should be used.

WARNING! This method causes the communication manager to loose all of its current state! That is, reactivating the communication manager again after this method has been called will result in having no #registerDevice(CommunicationBinding, IncomingMessageListener), CommunicationManager.registerService(int[], CommunicationBinding, IncomingMessageListener, LocalService) or #registerDiscovery(int[], DiscoveryBinding, IncomingMessageListener) registrations for incoming messages.

If this communication manager has already been stopped, this method must not do anything else other than quickly return.

Specified by:

stop in interface CommunicationManagerInternal

getAutoBindingFactory

public AutoBindingFactory getAutoBindingFactory()

Description copied from interface: CommunicationManager

Returns the AutoBindingFactory for the specified communicationManager to generate autobindings.

Specified by:

getAutoBindingFactory in interface CommunicationManager

Returns:

autoBindingFactory

getAllAvailableDiscoveryDomains

public Iterator getAllAvailableDiscoveryDomains()

Description copied from interface: CommunicationManager

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

Specified by:

getAllAvailableDiscoveryDomains in interface CommunicationManager

Returns:

iterator over all discovery domains

getAllAvailableDiscoveryDomainsSize

public int getAllAvailableDiscoveryDomainsSize()

Description copied from interface: CommunicationManager

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

Specified by:

getAllAvailableDiscoveryDomainsSize in interface CommunicationManager

Returns:

size of discovery domains

getAvailableOutgoingDiscoveryInfos

public DataStructure getAvailableOutgoingDiscoveryInfos(boolean includeXAddressInHello,
                                                        CredentialInfo localCredentialInfo)

Description copied from interface: CommunicationManager

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

Specified by:

getAvailableOutgoingDiscoveryInfos in interface CommunicationManager

Returns:

dataStructure with all available OutgoingDiscoveryInfos.

getMulticastAddressAndPortForOutgoingDiscoveryInfo

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

Description copied from interface: CommunicationManager

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

Specified by:

getMulticastAddressAndPortForOutgoingDiscoveryInfo in interface CommunicationManager

Returns:

getMulticastAddressAndPortForDiscoveryBinding

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

Description copied from interface: CommunicationManager

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

Specified by:

getMulticastAddressAndPortForDiscoveryBinding in interface CommunicationManager

Returns:

getDiscoveryBinding

public DiscoveryBinding getDiscoveryBinding(ConnectionInfo connectionInfo)

Description copied from interface: CommunicationManager

Returns a DiscoveryBinding for the given ConnectionInfo

Specified by:

getDiscoveryBinding in interface CommunicationManager

Returns:

discoverybindin, generated out of the connection.

getDiscoveryBinding

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

Description copied from interface: CommunicationManager

Returns a DiscoveryBinding for the given OutgoingDiscoveryInfo.

Specified by:

getDiscoveryBinding in interface CommunicationManager

Returns:

discoverysBinding, generated out of the OutgoingDiscoveryInfo

Throws:

java.io.IOException

getDiscoveryBindings

public DataStructure getDiscoveryBindings(CommunicationBinding binding)

Description copied from interface: CommunicationManager

Returns all DiscoveryBindings for the given CommunicationBinding.

Specified by:

getDiscoveryBindings in interface CommunicationManager

Returns:

dataStructure with all generated DiscoveryBinding.

getCommunicationBinding

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

Description copied from interface: CommunicationManager

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

Specified by:

getCommunicationBinding in interface CommunicationManager

Returns:

the communicationBinding for given discoveryBinding and path

getOutgoingDiscoveryInfos

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

Description copied from interface: CommunicationManager

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

Specified by:

getOutgoingDiscoveryInfos in interface CommunicationManager

Returns:

dataStructure with all generated OutgoingDiscoveryInfo

getOutgoingDiscoveryInfo

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

Description copied from interface: CommunicationManager

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

Specified by:

getOutgoingDiscoveryInfo in interface CommunicationManager

Returns:

dataStructure with all generated OutgoingDiscoveryInfo

getOutgoingDiscoveryInfo

public OutgoingDiscoveryInfo getOutgoingDiscoveryInfo(ConnectionInfo connectionInfo)

Description copied from interface: CommunicationManager

Returns a OutgoingDiscoveryInfo for given ConnectionInfo.

Specified by:

getOutgoingDiscoveryInfo in interface CommunicationManager

Returns:

outgoing discovery info for given connection info

getRandomApplicationDelay

public long getRandomApplicationDelay(ProtocolVersion dpwsVersion)

Description copied from interface: CommunicationManager

Returns the random application delay for given ProtocolVersion.

Specified by:

getRandomApplicationDelay in interface CommunicationManager

Returns:

random application delay as long.

registerDevice

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

Registers a device to receive (TCP) messages on a specified socket.

Specified by:

registerDevice in interface CommunicationManager

Parameters:

binding - HttpBinding.

listener -

Throws:

java.io.IOException - If the binding type does not match.

WS4DIllegalStateException

registerService

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

Registers a service to receive (TCP) messages on a specified socket.

Specified by:

registerService in interface CommunicationManager

Parameters:

messageTypes - Messages to receive. See for example MessageConstants.

binding - HttpBinding.

listener -

service - TODO

Throws:

java.io.IOException - If the binding type does not match.

WS4DIllegalStateException

registerDiscovery

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

Registers the framework to receive (UDP) discovery messages on a specified socket.

Specified by:

registerDiscovery in interface CommunicationManager

Parameters:

messageTypes - Messages to receive. See for example MessageConstants.

binding - DiscoveryBinding.

listener -

device - the device or null.

Throws:

java.io.IOException - If the binding type does not mat

WS4DIllegalStateException

unregisterDevice

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

Unregisters a device to stop receiving (TCP) messages on a specified socket.

Specified by:

unregisterDevice in interface CommunicationManager

Parameters:

binding - HttpBinding.

Throws:

java.io.IOException - If the binding type does not match.

WS4DIllegalStateException

unregisterService

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

Unregisters a service to stop receiving (TCP) messages on a specified socket.

Specified by:

unregisterService in interface CommunicationManager

Parameters:

messageTypes - Messages to receive. See for example MessageConstants.

binding - HttpBinding.

Throws:

java.io.IOException - If the binding type does not match.

WS4DIllegalStateException

unregisterDiscovery

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

Unregisters the framework to stop receiving (UDP) discovery messages on a specified socket.

Specified by:

unregisterDiscovery in interface CommunicationManager

Parameters:

messageTypes - Messages to receive. See for example MessageConstants.

binding - DiscoveryBinding.

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 - If the binding type does not mat

WS4DIllegalStateException

registerResource

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

Description copied from interface: CommunicationManager

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.

Specified by:

registerResource in interface CommunicationManager

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

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

Description copied from interface: CommunicationManager

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

Specified by:

unregisterResource in interface CommunicationManager

Parameters:

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

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

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

Description copied from interface: CommunicationManager

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

Specified by:

getResourceAsStream in interface CommunicationManager

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

getSOAPoverUDPServer

protected SOAPoverUDPServer getSOAPoverUDPServer(IPDiscoveryBinding binding,
                                                 boolean create)

send

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

Description copied from interface: CommunicationManager

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.

Specified by:

send in interface CommunicationManager

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

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

Description copied from interface: CommunicationManager

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

Specified by:

send in interface CommunicationManager

Parameters:

message - message message the request message to send

targetXAddrInfo - target address for the communication

credentialInfo - security information for secure communication

Throws:

WS4DIllegalStateException

send

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

Description copied from interface: CommunicationManager

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

Specified by:

send in interface CommunicationManager

Parameters:

message - message the request message to send

targetXAddrInfo - target address for the communication

credentialInfo - security information for secure communication

callback - callback where to deliver responses to the message

Throws:

WS4DIllegalStateException

checkAndSendTCPMessage

protected void checkAndSendTCPMessage(Message message,
                                      ResponseCallback callback,
                                      XAddressInfo targetXAddrInfo,
                                      CredentialInfo credentialInfo)

serializeMessageWithAttachments

public void serializeMessageWithAttachments(Message message,
                                            byte[] mimeBoundary,
                                            List attachments,
                                            java.io.OutputStream out,
                                            ConnectionInfo ci,
                                            AttributedURI optionalMessageId)
                                     throws java.io.IOException

Throws:

java.io.IOException

serializeMessageWithAttachments

public long serializeMessageWithAttachments(Message message,
                                            byte[] mimeBoundary,
                                            List attachments,
                                            java.io.ByteArrayOutputStream[] buffer,
                                            ConnectionInfo ci,
                                            AttributedURI optionalMessageId)
                                     throws java.io.IOException

Throws:

java.io.IOException

createProtocolInfo

public ProtocolInfo createProtocolInfo()

Description copied from interface: CommunicationManager

Returns the an instance of ProtocolInfo for this CommunicationManager.

Specified by:

createProtocolInfo in interface CommunicationManager

Returns:

the protocol info.

createProtocolInfo

public ProtocolInfo createProtocolInfo(ProtocolVersion version)

Description copied from interface: CommunicationManager

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

Specified by:

createProtocolInfo in interface CommunicationManager

Parameters:

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

Returns:

the protocol info for the given version.

getSupportedVersions

public HashSet getSupportedVersions()

Description copied from interface: CommunicationManager

Returns a set of supported versions by this CommunicationManager.

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

Specified by:

getSupportedVersions in interface CommunicationManager

Returns:

a set of supported versions.

supportsAddressingNamespace

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

Description copied from interface: CommunicationManager

Checks if the given namespace would be supported.

Specified by:

supportsAddressingNamespace in interface CommunicationManager

Returns:

true if supports namespace, false if not.

Throws:

VersionMismatchException

supportsDiscoveryNamespace

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

Throws:

VersionMismatchException

supportsEventingNamespace

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

Throws:

VersionMismatchException

getDeviceTypes

public QNameSet getDeviceTypes(LocalDevice device)

Specified by:

getDeviceTypes in interface CommunicationManager

getDeviceType

public QName getDeviceType(ProtocolVersion version)

Specified by:

getDeviceType in interface CommunicationManager

Parameters:

version -

Returns:

createActionNotSupportedFault

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

Faults

Specified by:

createActionNotSupportedFault in interface CommunicationManager

Returns:

faultMessage

createEndpointUnavailableFault

public FaultMessage createEndpointUnavailableFault(Message request)

Description copied from interface: CommunicationManager

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

Specified by:

createEndpointUnavailableFault in interface CommunicationManager

Returns:

faultMessage

createGenericFault

public FaultMessage createGenericFault(Message request,
                                       java.lang.String reason)

createGenericFault

public FaultMessage createGenericFault(Message request,
                                       java.lang.String reason,
                                       AttributedURI relatesTo)

createMessageAddressingHeaderRequiredFault

public FaultMessage createMessageAddressingHeaderRequiredFault()

Description copied from interface: CommunicationManager

Creates an "MessageAddressingHeaderRequirede" FaultMessage.

Specified by:

createMessageAddressingHeaderRequiredFault in interface CommunicationManager

Returns:

faultMessage

createAuthorizationFault

public FaultMessage createAuthorizationFault(Message request)

Description copied from interface: CommunicationManager

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

Specified by:

createAuthorizationFault in interface CommunicationManager

Returns:

faultMessage

createInvocationFault

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

Description copied from interface: CommunicationManager

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

Specified by:

createInvocationFault in interface CommunicationManager

Returns:

faultMessage

createInvalidAddressingHeaderFault

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

Description copied from interface: CommunicationManager

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

Specified by:

createInvalidAddressingHeaderFault in interface CommunicationManager

Returns:

faultMessage

createSubscriptionFault

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

Description copied from interface: CommunicationManager

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

Specified by:

createSubscriptionFault in interface CommunicationManager

Returns:

faultMessage

createEventingException

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

Exceptions

Specified by:

createEventingException in interface CommunicationManager

Returns:

eventingException

createInvocationException

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

Description copied from interface: CommunicationManager

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

Specified by:

createInvocationException in interface CommunicationManager

Returns:

invocationException

createInvocationExceptionSOAPFault

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

Description copied from interface: CommunicationManager

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

Specified by:

createInvocationExceptionSOAPFault in interface CommunicationManager

Returns:

invocationException

supportsEventingFilterDialect

public boolean supportsEventingFilterDialect(URI dialect,
                                             ProtocolInfo protocolInfo)

UTIL

Specified by:

supportsEventingFilterDialect in interface CommunicationManager

Returns:

true if supports dialect, false if not.

isTransportAddress

public boolean isTransportAddress(URI uri)

Returns true if the uri represents a HTTP, HTTPS or SOAP-over-UDP transport address.

Specified by:

isTransportAddress in interface CommunicationManager

Returns:

true if the uri represents a HTTP, HTTPS or SOAP-over-UDP transport address.

validateMessage

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

Description copied from interface: CommunicationManager

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

Specified by:

validateMessage in interface CommunicationManager

Returns:

id of validation

getAddressFilter

public AddressFilter getAddressFilter()

Description copied from interface: CommunicationManager

Address filter

Specified by:

getAddressFilter in interface CommunicationManager

setAddressFilter

public void setAddressFilter(AddressFilter filter)

Description copied from interface: CommunicationManager

TODO will be removed in future

Specified by:

setAddressFilter in interface CommunicationManager

checkIfAddressIsAnyLocalThenInterface

public java.lang.String checkIfAddressIsAnyLocalThenInterface(java.lang.String addr,
                                                              ConnectionInfo connectionInfo)

Specified by:

checkIfAddressIsAnyLocalThenInterface in interface CommunicationManager

newDescriptionParser

public DescriptionParser newDescriptionParser()

Specified by:

newDescriptionParser in interface CommunicationManager

Returns:

a new description parser.

newDescriptionSerializer

public DescriptionSerializer newDescriptionSerializer()

Specified by:

newDescriptionSerializer in interface CommunicationManager

Returns:

a new description serializer.

containsAllDeviceTypes

public boolean containsAllDeviceTypes(QNameSet searchTypes,
                                      QNameSet types)

Specified by:

containsAllDeviceTypes in interface CommunicationManager

Returns:

containsAllServiceTypes

public boolean containsAllServiceTypes(QNameSet searchTypes,
                                       QNameSet types)

Specified by:

containsAllServiceTypes in interface CommunicationManager

Returns:

containsAllSearchScopes

public boolean containsAllSearchScopes(ScopeSet searchScopes,
                                       ScopeSet deviceScopes)

Specified by:

containsAllSearchScopes in interface CommunicationManager

Returns:

adaptServiceTypes

public QNameSet adaptServiceTypes(QNameSet qnames)

Description copied from interface: CommunicationManager

CommunicationManager specific adaptation of service-types.

Specified by:

adaptServiceTypes in interface CommunicationManager

Returns:

adaptDeviceTypes

public QNameSet adaptDeviceTypes(QNameSet qnames)

Description copied from interface: CommunicationManager

CommunicationManager specific adaptation of device-types.

Specified by:

adaptDeviceTypes in interface CommunicationManager

Returns:

createDynamicEndpointReference

public EndpointReference createDynamicEndpointReference()

Specified by:

createDynamicEndpointReference in interface CommunicationManager

getMetadataValidator

public MetadataValidator getMetadataValidator()

Specified by:

getMetadataValidator in interface CommunicationManager

getChildren

public Iterator getChildren(DeviceReference devRef,
                            boolean doDiscovery)
                     throws CommunicationException

Description copied from interface: CommunicationManager

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.

Specified by:

getChildren in interface CommunicationManager

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