Package org.somda.sdc.dpws.service

Interface HostedServiceProxy

  • All Implemented Interfaces:
    org.somda.sdc.dpws.soap.RequestResponseClient , org.somda.sdc.dpws.soap.interception.InterceptorHandler 
    
public interface HostedServiceProxy
 implements RequestResponseClient

    Hosted service proxy of a client.

    • 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 HostedServiceType getType() Gets the hosted service metadata requestable via WS-TransferGet.
      abstract RequestResponseClient getRequestResponseClient() Gets the request-response client used to send request messages and receive their response.
      abstract EventSinkAccess getEventSinkAccess() Gets the event sink that can be used to subscribe and manage subscriptions of the hosted service.
      abstract String getActiveEprAddress() Gets the physical address that is actively being used to send requests.

      • Methods inherited from class org.somda.sdc.dpws.soap.RequestResponseClient

        sendRequestResponse

      • Methods inherited from class org.somda.sdc.dpws.soap.interception.InterceptorHandler

        register

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • getType

         abstract HostedServiceType getType()

        Gets the hosted service metadata requestable via WS-TransferGet.

        Returns:

        a copy of the hosted service metadata received from the network.

      • getEventSinkAccess

         abstract EventSinkAccess getEventSinkAccess()

        Gets the event sink that can be used to subscribe and manage subscriptions of the hosted service.

        Attention: the event sink only works if the underlying hosted service acts as an event source. It is up to the user check the availability in advance, otherwise calls will end up in SOAP faults.

        Returns:

        the EventSinkAccess instance.

      • getActiveEprAddress

         abstract String getActiveEprAddress()

        Gets the physical address that is actively being used to send requests.

        A hosted service can have different physical addresses in order to be accessible. The one that is returned with this function is the one that was used to initially resolve metadata (GetMetadata request).

        Returns:

        the currently active EPR address.