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

Interface WsDiscoveryClient

All Superinterfaces:

Interceptor

All Known Implementing Classes:

WsDiscoveryClientInterceptor

public interface WsDiscoveryClient
extends Interceptor

WS-Discovery Client interface.

See Also:

Conceptual Message Content

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<org.somda.sdc.dpws.soap.wsdiscovery.model.ProbeMatchesType>	sendDirectedProbe(RequestResponseClient rrClient, List<QName> types, List<String> scopes, MatchBy matchBy)	Sends a directed probe to a device.
com.google.common.util.concurrent.ListenableFuture<Integer>	sendProbe(String probeId, Collection<QName> types, Collection<String> scopes, MatchBy matchBy)	Sends a probe message using the given parameters.
com.google.common.util.concurrent.ListenableFuture<Integer>	sendProbe(String probeId, Collection<QName> types, Collection<String> scopes, MatchBy matchBy, 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<org.somda.sdc.dpws.soap.wsdiscovery.model.ResolveMatchesType>	sendResolve(org.somda.sdc.dpws.soap.wsaddressing.model.EndpointReferenceType epr)	Sends a resolve message for a given endpoint reference.
void	unregisterHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)	Unregister an observer handling Hello, Bye and ProbeMatches messages.

Method Detail

sendDirectedProbe

com.google.common.util.concurrent.ListenableFuture<org.somda.sdc.dpws.soap.wsdiscovery.model.ProbeMatchesType> sendDirectedProbe(RequestResponseClient rrClient,
                                                                                                                                 List<QName> types,
                                                                                                                                 List<String> scopes,
                                                                                                                                 @Nullable
                                                                                                                                 MatchBy matchBy)

Sends a directed probe to a device.

Parameters:

rrClient - to send request on

types - to probe for

scopes - to probe for

matchBy - the scopes matching rule, or null to use the default http://docs.oasis-open.org/ws-dd/ns/discovery/2009/01/rfc3986.

Returns:

future providing probe matches response

sendProbe

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

Sends a probe message using the given parameters.

ProbeMatches messages are handled by the observers.

Parameters:

probeId - of the probe

types - to probe for

scopes - to probe for

matchBy - the scopes matching rule, or null to use the default http://docs.oasis-open.org/ws-dd/ns/discovery/2009/01/rfc3986.

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:

registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver)

sendProbe

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

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

ProbeMatches messages are handled by the observers.

Parameters:

probeId - of the probe

types - to probe for

scopes - to probe for

matchBy - the scopes matching rule, or null to use the default http://docs.oasis-open.org/ws-dd/ns/discovery/2009/01/rfc3986.

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:

registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver)

sendResolve

com.google.common.util.concurrent.ListenableFuture<org.somda.sdc.dpws.soap.wsdiscovery.model.ResolveMatchesType> sendResolve(org.somda.sdc.dpws.soap.wsaddressing.model.EndpointReferenceType epr)
                                                                                                                      throws MarshallingException,
                                                                                                                             TransportException,
                                                                                                                             InterceptorException

Sends a resolve message for a given endpoint reference.

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

void registerHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)

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

Parameters:

observer - to listen on

unregisterHelloByeAndProbeMatchesObserver

void unregisterHelloByeAndProbeMatchesObserver(HelloByeAndProbeMatchesObserver observer)

Unregister an observer handling Hello, Bye and ProbeMatches messages.

Parameters:

observer - to unregister