Package org.somda.sdc.dpws.soap.wsdiscovery

Class WsDiscoveryClientInterceptor

java.lang.Object

org.somda.sdc.dpws.soap.wsdiscovery.WsDiscoveryClientInterceptor

All Implemented Interfaces:

Interceptor, WsDiscoveryClient

public class WsDiscoveryClientInterceptor
extends Object
implements WsDiscoveryClient

Default implementation of WsDiscoveryClient.

Method Summary

Modifier and Type	Method	Description
void	registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)	Register an observer to handle Hello, Bye and ProbeMatches messages.
com.google.common.util.concurrent.ListenableFuture<ProbeMatchesType>	sendDirectedProbe(RequestResponseClient rrClient, List<QName> types, List<String> scopes)	Sends a directed probe to a device.
com.google.common.util.concurrent.ListenableFuture<Integer>	sendProbe(String probeId, Collection<QName> types, Collection<String> scopes)	Sends a probe message using the given parameters.
com.google.common.util.concurrent.ListenableFuture<Integer>	sendProbe(String probeId, Collection<QName> types, Collection<String> scopes, Integer maxResults)	Sends a probe message using the given parameters with a limited number of results until future finishes.
com.google.common.util.concurrent.ListenableFuture<ResolveMatchesType>	sendResolve(EndpointReferenceType epr)	Sends a resolve message for a given endpoint reference.
void	unregisterHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)	Unregister an observer handling Hello, Bye and ProbeMatches messages.

Methods inherited from class java.lang.Object

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

Method Detail

sendDirectedProbe

public com.google.common.util.concurrent.ListenableFuture<ProbeMatchesType> sendDirectedProbe(RequestResponseClient rrClient,
                                                                                              List<QName> types,
                                                                                              List<String> scopes)

Description copied from interface: WsDiscoveryClient

Sends a directed probe to a device.

Specified by:

sendDirectedProbe in interface WsDiscoveryClient

Parameters:

rrClient - to send request on

types - to probe for

scopes - to probe for

Returns:

future providing probe matches response

TODO LDe: This is inconsistent with the rest, why does it not throw any exceptions?

sendProbe

public com.google.common.util.concurrent.ListenableFuture<Integer> sendProbe(String probeId,
                                                                             Collection<QName> types,
                                                                             Collection<String> scopes,
                                                                             Integer maxResults)
                                                                      throws MarshallingException,
                                                                             TransportException,
                                                                             InterceptorException

Description copied from interface: WsDiscoveryClient

Sends a probe message using the given parameters with a limited number of results until future finishes.

ProbeMatches messages are handled by the observers.

Specified by:

sendProbe in interface WsDiscoveryClient

Parameters:

probeId - of the probe

types - to probe for

scopes - to probe for

maxResults - number of results to wait for at most

Returns:

Future containing the number of matches within the given timeout.

Throws:

MarshallingException - on marshalling issues in the outgoing message

TransportException - on transport issues in the outgoing message

InterceptorException - on preprocessing issues with the outgoing message

See Also:

WsDiscoveryClient.registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver)

sendProbe

public com.google.common.util.concurrent.ListenableFuture<Integer> sendProbe(String probeId,
                                                                             Collection<QName> types,
                                                                             Collection<String> scopes)
                                                                      throws MarshallingException,
                                                                             TransportException,
                                                                             InterceptorException

Description copied from interface: WsDiscoveryClient

Sends a probe message using the given parameters.

ProbeMatches messages are handled by the observers.

Specified by:

sendProbe in interface WsDiscoveryClient

Parameters:

probeId - of the probe

types - to probe for

scopes - to probe for

Returns:

Future containing the number of matches within the given timeout.

Throws:

MarshallingException - on marshalling issues in the outgoing message

TransportException - on transport issues in the outgoing message

InterceptorException - on preprocessing issues with the outgoing message

See Also:

WsDiscoveryClient.registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver)

sendResolve

public com.google.common.util.concurrent.ListenableFuture<ResolveMatchesType> sendResolve(EndpointReferenceType epr)
                                                                                   throws MarshallingException,
                                                                                          TransportException,
                                                                                          InterceptorException

Description copied from interface: WsDiscoveryClient

Sends a resolve message for a given endpoint reference.

Specified by:

sendResolve in interface WsDiscoveryClient

Parameters:

epr - to resolve for

Returns:

future providing resolve matches response

Throws:

MarshallingException - on marshalling issues in the outgoing message

TransportException - on transport issues in the outgoing message

InterceptorException - on preprocessing issues with the outgoing message

registerHelloByeAndProbeMatchesObserver

public void registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)

Description copied from interface: WsDiscoveryClient

Register an observer to handle Hello, Bye and ProbeMatches messages.

Specified by:

registerHelloByeAndProbeMatchesObserver in interface WsDiscoveryClient

Parameters:

observer - to listen on

unregisterHelloByeAndProbeMatchesObserver

public void unregisterHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)

Description copied from interface: WsDiscoveryClient

Unregister an observer handling Hello, Bye and ProbeMatches messages.

Specified by:

unregisterHelloByeAndProbeMatchesObserver in interface WsDiscoveryClient

Parameters:

observer - to unregister