org.ws4d.java.communication.callback

Class LocalResponseCoordinatorCallback

java.lang.Object

org.ws4d.java.communication.callback.DefaultResponseCallback

org.ws4d.java.communication.callback.LocalResponseCoordinatorCallback

All Implemented Interfaces:

ResponseCallback

public class LocalResponseCoordinatorCallback
extends DefaultResponseCallback

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_GET
static int	TYPE_GETMETADATA
static int	TYPE_RESOLVE

Fields inherited from class org.ws4d.java.communication.callback.DefaultResponseCallback

targetXAddressInfo

Constructor Summary

Constructors

Constructor and Description
LocalResponseCoordinatorCallback(XAddressInfo targetXAddressInfo, ResponseCallback callback, AttributedURI[] optionalMessageIDs, int messageType)

Method Summary

Modifier and Type	Method and Description
OperationDescription	getOperation()
void	handle(GetMessage get, GetResponseMessage getResponse, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Receives a GetResponseMessage.
void	handle(GetMetadataMessage getMetadata, GetMetadataResponseMessage getMetadataResponse, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Receives a GetMetadataResponseMessage.
void	handle(Message request, FaultMessage fault, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Receives a FaultMessage in response to a previously sent request message.
void	handle(ResolveMessage resolve, ResolveMatchesMessage resolveMatches, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Receives a ResolveMatchesMessage in response to a previously sent ResolveMessage.
void	handleMalformedResponseException(Message request, java.lang.Exception exception, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Called when an exception occurs while receiving, decoding or processing the response message to a previously sent request.
void	handleNoContent(Message request, java.lang.String reason, ConnectionInfo connectionInfo, AttributedURI optionalMessageId)
void	handleTimeout(Message request, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Called when an attempt to receive responses to a previously sent request message passed to CommunicationManager.send(Message, ProtocolInfo, DataStructure, ResponseCallback) timeouted.
void	handleTransmissionException(Message request, java.lang.Exception exception, ConnectionInfo connectionInfo, AttributedURI optionalMessageId) Called when an exception arises while sending the request message.

Methods inherited from class org.ws4d.java.communication.callback.DefaultResponseCallback

getEvent, getTargetAddress, handle, handle, handle, handle, handle, handle, logResponse, requestStartedWithTimeout, setTargetAddress

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_RESOLVE

public static final int TYPE_RESOLVE

See Also:

Constant Field Values

TYPE_GET

public static final int TYPE_GET

See Also:

Constant Field Values

TYPE_GETMETADATA

public static final int TYPE_GETMETADATA

See Also:

Constant Field Values

Constructor Detail

LocalResponseCoordinatorCallback

public LocalResponseCoordinatorCallback(XAddressInfo targetXAddressInfo,
                                        ResponseCallback callback,
                                        AttributedURI[] optionalMessageIDs,
                                        int messageType)

Method Detail

handle

public void handle(ResolveMessage resolve,
                   ResolveMatchesMessage resolveMatches,
                   ConnectionInfo connectionInfo,
                   AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Receives a ResolveMatchesMessage in response to a previously sent ResolveMessage. This receiving ResponseCallback instance is the one passed as fourth argument to the send method.
Note that it is possible (depending on the underlying technology implemented by the concrete CommunicationManager in use) to receive none or exactly one ResolveMatchesMessage in response to a single sent ResolveMessage. This method would thus accordingly either not get called at all, or get called once.

If no responses to the sent resolve message are received within a protocol-specific time period, method ResponseCallback.handleTimeout(Message, ConnectionInfo, AttributedURI) will be called.

Specified by:

handle in interface ResponseCallback

Overrides:

handle in class DefaultResponseCallback

Parameters:

resolve - the original request message

resolveMatches - a message containing a response to the previously sent request

connectionInfo - protocol (aka. technology) specific addressing information attached to the received message; this is especially useful when sending resolve request messages over multiple different technologies like DPWS,UPNP, Bluetooth, etc. (which can be done by specifying respective DiscoveryDomains); the supplied connectionInfo enables in such cases the requester to distinguish which technology the result was obtained over

handle

public void handle(GetMessage get,
                   GetResponseMessage getResponse,
                   ConnectionInfo connectionInfo,
                   AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Receives a GetResponseMessage. The corresponding GetMessage has previously been sent by passing this ResponseCallback instance as the fourth argument to the send method.

Each GetMessage may result in a call to either this method (in case of successful two-way communication), or to methods:

• ResponseCallback.handleTransmissionException(Message, Exception, ConnectionInfo, AttributedURI) in case of a failure while sending the request message
• ResponseCallback.handle(Message, FaultMessage, ConnectionInfo, AttributedURI) in case of a failure during request processing on the server side
• ResponseCallback.handleMalformedResponseException(Message, Exception, ConnectionInfo, AttributedURI) in case of a failure during response processing on this side
• ResponseCallback.handleTimeout(Message, ConnectionInfo, AttributedURI) in case of a timeout while waiting for responses to the sent request.

Specified by:

handle in interface ResponseCallback

Overrides:

handle in class DefaultResponseCallback

Parameters:

get - the original request message

getResponse - a message containing the response to the previously sent request

connectionInfo - protocol (aka. technology) specific addressing information attached to the received message

handle

public void handle(GetMetadataMessage getMetadata,
                   GetMetadataResponseMessage getMetadataResponse,
                   ConnectionInfo connectionInfo,
                   AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Receives a GetMetadataResponseMessage. The corresponding GetMetadataMessage has previously been sent by passing this ResponseCallback instance as the fourth argument to the send method.

Each GetMetadataMessage may result in a call to either this method (in case of successful two-way communication), or to methods:

• ResponseCallback.handleTransmissionException(Message, Exception, ConnectionInfo, AttributedURI) in case of a failure while sending the request message
• ResponseCallback.handle(Message, FaultMessage, ConnectionInfo, AttributedURI) in case of a failure during request processing on the server side
• ResponseCallback.handleMalformedResponseException(Message, Exception, ConnectionInfo, AttributedURI) in case of a failure during response processing on this side
• ResponseCallback.handleTimeout(Message, ConnectionInfo, AttributedURI) in case of a timeout while waiting for responses to the sent request.

Specified by:

handle in interface ResponseCallback

Overrides:

handle in class DefaultResponseCallback

Parameters:

getMetadata - the original request message

getMetadataResponse - a message containing the response to the previously sent request

connectionInfo - protocol (aka. technology) specific addressing information attached to the received message

handle

public void handle(Message request,
                   FaultMessage fault,
                   ConnectionInfo connectionInfo,
                   AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Receives a FaultMessage in response to a previously sent request message.

A fault is raised on the responding side while processing the request message and then sent back to the requester (aka. this side). It is explicitly NOT created on this side while processing the received response (see method ResponseCallback.handleMalformedResponseException(Message, Exception, ConnectionInfo, AttributedURI) for the latter case).

Specified by:

handle in interface ResponseCallback

Overrides:

handle in class DefaultResponseCallback

Parameters:

request - the original request message

fault - the fault generated by the responding side

connectionInfo - protocol (aka. technology) specific addressing information attached to the received message

handleTimeout

public void handleTimeout(Message request,
                          ConnectionInfo connectionInfo,
                          AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Called when an attempt to receive responses to a previously sent request message passed to CommunicationManager.send(Message, ProtocolInfo, DataStructure, ResponseCallback) timeouted. This can only happen when using an unreliable connectionless transport layer for message transmission, such as UDP. Note that any other error related to sending the original request message is notified by the callback method ResponseCallback.handleTransmissionException(Message, Exception, ConnectionInfo, AttributedURI) . The original (request) message that was meant to be sent is passed as argument request.

Specified by:

handleTimeout in interface ResponseCallback

Overrides:

handleTimeout in class DefaultResponseCallback

Parameters:

request - the message meant to be sent, which resulted in a timeout

connectionInfo - protocol (aka. technology) specific addressing information attached to the received message

handleTransmissionException

public void handleTransmissionException(Message request,
                                        java.lang.Exception exception,
                                        ConnectionInfo connectionInfo,
                                        AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Called when an exception arises while sending the request message. This could be e.g. due to network reachability reasons, an IO problem within the transport connection, an invalid message construct, etc.

Specified by:

handleTransmissionException in interface ResponseCallback

Overrides:

handleTransmissionException in class DefaultResponseCallback

Parameters:

request - the request message which was meant to be sent when the exception occurred

exception - the exception cause while sending the request message

connectionInfo - protocol (aka. technology) specific addressing information related to the transmission exception

handleMalformedResponseException

public void handleMalformedResponseException(Message request,
                                             java.lang.Exception exception,
                                             ConnectionInfo connectionInfo,
                                             AttributedURI optionalMessageId)

Description copied from interface: ResponseCallback

Called when an exception occurs while receiving, decoding or processing the response message to a previously sent request. The exception is passed to argument exception

Specified by:

handleMalformedResponseException in interface ResponseCallback

Overrides:

handleMalformedResponseException in class DefaultResponseCallback

Parameters:

request - the original request message

exception - the exception caused during processing the response

connectionInfo - protocol (aka. technology) specific addressing information related to the malformed response

handleNoContent

public void handleNoContent(Message request,
                            java.lang.String reason,
                            ConnectionInfo connectionInfo,
                            AttributedURI optionalMessageId)

Specified by:

handleNoContent in interface ResponseCallback

Overrides:

handleNoContent in class DefaultResponseCallback

getOperation

public OperationDescription getOperation()

Specified by:

getOperation in interface ResponseCallback

Overrides:

getOperation in class DefaultResponseCallback