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

Interface WsDiscoveryTargetService

  • All Implemented Interfaces:
    org.somda.sdc.dpws.soap.interception.Interceptor 
    
public interface WsDiscoveryTargetService
 implements Interceptor

    WS-Discovery Target Service interface.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • setTypes

         abstract void setTypes(List<QName> qNames)

        Thread-safe function to set the list of QNames.

        Parameters:
        qNames - the list of QNames to set.

      • getTypes

         abstract List<QName> getTypes()

        Thread-safe function to get the list of QNames.

        Returns:

        the list of QNames.

      • setScopes

         abstract 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

         abstract List<String> getScopes()

        Thread-safe function to get the list of scope URIs.

        Returns:

        the list of scope URIs.

      • setXAddrs

         abstract void setXAddrs(List<String> xAddrs)

        Thread-safe function to set the list of XAddr URIs.

        Parameters:
        xAddrs - the list of XAddr URIs.

      • getXAddrs

         abstract List<String> getXAddrs()

        Thread-safe function to get the list of XAddr URIs.

        Returns:

        the list of XAddr URIs.

      • setMetadataModified

         abstract 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

         abstract UnsignedInteger getMetadataVersion()

        Thread-safe function to get the metadata version.

        Returns:

        the metadata version.

      • sendHello

         abstract UnsignedInteger sendHello()

        Blocking function to send out a Hello message.

        This is a shorthand function to sendHello.

        Returns:

        the metadata version that has been attached to the Hello message.

      • sendHello

         abstract UnsignedInteger sendHello(boolean forceNewMetadataVersion)

        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.

      • sendBye

         abstract void sendBye()

        Blocking function to send out a Bye message.