org.ws4d.java.communication.protocol.soap.generator

Interface Message2SOAPGenerator

All Known Implementing Classes:

DefaultMessage2SOAPGenerator

public interface Message2SOAPGenerator

Method Summary

Modifier and Type	Method and Description
ByteArrayBuffer	generateSOAPMessage(Message msg, IPConnectionInfo connectionInfo, AttributedURI optionalMessageId, boolean includeXAddrsInUDPHello) Serialize an DPWS Message Object to an array of bytes.
void	generateSOAPMessage(java.io.OutputStream out, Message msg, IPConnectionInfo connectionInfo, AttributedURI optionalMessageId) Serialize an DPWS Message Object to the given output stream.
ByteArrayBuffer	getCurrentBuffer() Return the current buffer of this instance
void	returnCurrentBufferToCache() Return the current buffer of this instance to the cache for reuse

Method Detail

generateSOAPMessage

void generateSOAPMessage(java.io.OutputStream out,
                         Message msg,
                         IPConnectionInfo connectionInfo,
                         AttributedURI optionalMessageId)
                  throws java.lang.IllegalArgumentException,
                         WS4DIllegalStateException,
                         java.io.IOException,
                         DiscoveryProxyProbeMatchesException

Serialize an DPWS Message Object to the given output stream.

Parameters:

out - stream, to which the element should be serialized.

connectionInfo -

msg, - which is use to get the Information

Throws:

java.lang.IllegalArgumentException

WS4DIllegalStateException

java.io.IOException

DiscoveryProxyProbeMatchesException

generateSOAPMessage

ByteArrayBuffer generateSOAPMessage(Message msg,
                                    IPConnectionInfo connectionInfo,
                                    AttributedURI optionalMessageId,
                                    boolean includeXAddrsInUDPHello)
                             throws java.io.IOException,
                                    DiscoveryProxyProbeMatchesException

Serialize an DPWS Message Object to an array of bytes.

ATTENTION: When the message generated by this method is not needed anymore return it for reuse by calling returnBuffer(ByteArrayBuffer buffer)

Parameters:

msg - the message which is use to get the Information

Returns:

the message-buffer containing the generated message representation

Throws:

java.io.IOException

DiscoveryProxyProbeMatchesException

returnCurrentBufferToCache

void returnCurrentBufferToCache()

Return the current buffer of this instance to the cache for reuse

Parameters:

buffer - the message-buffer returned by the latest invocation of generateSOAPMessage(Message msg, ConnectionInfo ci)

getCurrentBuffer

ByteArrayBuffer getCurrentBuffer()

Return the current buffer of this instance

Returns:

the message-buffer returned by the latest invocation of generateSOAPMessage(Message msg, ConnectionInfo ci)