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

Interface WsDiscoveryTargetService

All Superinterfaces:
Interceptor
All Known Implementing Classes:
WsDiscoveryTargetServiceInterceptor
public interface WsDiscoveryTargetService extends Interceptor
WS-Discovery Target Service interface.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    EndpointReferenceType
    getEndpointReference()
     
    MatchBy
    getMatchBy()
    Thread-safe function to get the MatchBy rule.
    com.google.common.primitives.UnsignedInteger
    getMetadataVersion()
    Thread-safe function to get the metadata version.
    List<String>
    getScopes()
    Thread-safe function to get the list of scope URIs.
    List<QName>
    getTypes()
    Thread-safe function to get the list of QNames.
    List<String>
    getXAddrs()
    Thread-safe function to get the list of XAddr URIs.
    void
    sendBye()
    Blocking function to send out a Bye message.
    com.google.common.primitives.UnsignedInteger
    sendHello()
    Blocking function to send out a Hello message.
    com.google.common.primitives.UnsignedInteger
    sendHello(boolean forceNewMetadataVersion)
    Blocking function to send out a Hello message.
    void
    setMatchBy(MatchBy matchBy)
    Thread-safe function to set the MatchBy rule.
    void
    setMetadataModified()
    Thread-safe function to explicitly set the target service metadata to be modified (thread-safe).
    void
    setScopes(List<String> uris)
    Thread-safe function to set the list of scope URIs.
    void
    setTypes(List<QName> qNames)
    Thread-safe function to set the list of QNames.
    void
    setXAddrs(List<String> xAddrs)
    Thread-safe function to set the list of XAddr URIs.

  • Method Details

    • getEndpointReference

      EndpointReferenceType getEndpointReference()

    • setTypes

      void setTypes(List<QName> qNames)
      Thread-safe function to set the list of QNames.
      Parameters:
      qNames - the list of QNames to set.

    • getTypes

      List<QName> getTypes()
      Thread-safe function to get the list of QNames.
      Returns:
      the list of QNames.

    • setScopes

      void setScopes(List<String> uris)
      Thread-safe function to set the list of scope URIs.
      Parameters:
      uris - the list of scope URIs to set.

    • getScopes

      List<String> getScopes()
      Thread-safe function to get the list of scope URIs.
      Returns:
      the list of scope URIs.

    • setXAddrs

      void setXAddrs(List<String> xAddrs)
      Thread-safe function to set the list of XAddr URIs.
      Parameters:
      xAddrs - the list of XAddr URIs.

    • getXAddrs

      List<String> getXAddrs()
      Thread-safe function to get the list of XAddr URIs.
      Returns:
      the list of XAddr URIs.

    • setMatchBy

      void setMatchBy(MatchBy matchBy)
      Thread-safe function to set the MatchBy rule.
      Parameters:
      matchBy - the MatchBy rule to set.

    • getMatchBy

      MatchBy getMatchBy()
      Thread-safe function to get the MatchBy rule.
      Returns:
      the MatchBy rule.

    • setMetadataModified

      void setMetadataModified()
      Thread-safe function to explicitly set the target service metadata to be modified (thread-safe).

      This is useful if the metadata change does not belong to, e.g., Types and Scopes.

    • getMetadataVersion

      com.google.common.primitives.UnsignedInteger getMetadataVersion()
      Thread-safe function to get the metadata version.
      Returns:
      the metadata version.

    • sendHello

      com.google.common.primitives.UnsignedInteger sendHello() throws MarshallingException, TransportException, InterceptorException
      Blocking function to send out a Hello message.

      This is a shorthand function to sendHello(boolean).

      Returns:
      the metadata version that has been attached to the Hello message.
      Throws:
      MarshallingException - if marshalling the Hello message fails.
      TransportException - if there is any problem on the transport layer.
      InterceptorException - if one of the interceptors pops up with an error.

    • sendHello

      com.google.common.primitives.UnsignedInteger sendHello(boolean forceNewMetadataVersion) throws MarshallingException, TransportException, InterceptorException
      Blocking function to send out a Hello message.
      Parameters:
      forceNewMetadataVersion - set to true to force incrementing the metadata version, or false to not do so.
      Returns:
      the metadata version that has been attached to the Hello message.
      Throws:
      MarshallingException - if marshalling the Hello message fails.
      TransportException - if there is any problem on the transport layer.
      InterceptorException - if one of the interceptors pops up with an error.

    • sendBye

      void sendBye() throws MarshallingException, TransportException, InterceptorException
      Blocking function to send out a Bye message.
      Throws:
      MarshallingException - if marshalling the Bye message fails.
      TransportException - if there is any problem on the transport layer.
      InterceptorException - if one of the interceptors pops up with an error.