Package org.somda.sdc.dpws.soap.wseventing

Interface SourceSubscriptionManager

  • All Implemented Interfaces:
    com.google.common.util.concurrent.Service , org.somda.sdc.dpws.soap.wseventing.SubscriptionManager 
    
public interface SourceSubscriptionManager
 implements SubscriptionManager, Service

    Subscription manager interface that is used by event sources.

    • 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 void offerNotification(Notification notification) Inserts the notification into the subscription manager's queue.
      abstract void offerEndTo(SoapMessage endToMessage) Tries to send a custom end-to message to the event sink.
      abstract void offerEndTo(WsEventingStatus status) Tries to send an end-to message to the event sink of the given status.
      abstract void renew(Duration expires) Resets the expires duration.
      abstract Optional<String> getCallerId() Returns a string identifying the certificate of the consumer that started the subscription.

      • Methods inherited from class org.somda.sdc.dpws.soap.wseventing.SubscriptionManager

        getEndTo, getExpires, getExpiresTimeout, getFilterDialect, getFilters, getNotifyTo, getSubscriptionId, getSubscriptionManagerEpr

      • Methods inherited from class com.google.common.util.concurrent.Service

        addListener, awaitRunning, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

    • Method Detail

      • offerNotification

         abstract void offerNotification(Notification notification)

        Inserts the notification into the subscription manager's queue.

        The manager is shut down

        • on first delivery failure or
        • in case there is queue overflow or a delivery failure.
        Parameters:
        notification - the notification to add.

      • offerEndTo

         abstract void offerEndTo(SoapMessage endToMessage)

        Tries to send a custom end-to message to the event sink.

        This is a non-blocking call that silently ignores failed delivery. This method ends the SourceSubscriptionManager once the message has been delivered.

        Parameters:
        endToMessage - the message to send.

      • offerEndTo

         abstract void offerEndTo(WsEventingStatus status)

        Tries to send an end-to message to the event sink of the given status.

        This is a non-blocking call that silently ignores failed delivery. This method ends the SourceSubscriptionManager once the status has been delivered.

        Parameters:
        status - the status for which a SubscriptionEnd message will be sent.

      • renew

         abstract void renew(Duration expires)

        Resets the expires duration.

        This will also affect getExpiresTimeout.

        Parameters:
        expires - the duration to reset.

      • getCallerId

         abstract Optional<String> getCallerId()

        Returns a string identifying the certificate of the consumer that started the subscription.

        Returns:

        an identifying string, or empty, if no such string exists.