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

Interface SourceSubscriptionManager

All Superinterfaces:
com.google.common.util.concurrent.Service, SubscriptionManager
All Known Implementing Classes:
SourceSubscriptionManagerImpl
public interface SourceSubscriptionManager extends SubscriptionManager, com.google.common.util.concurrent.Service
Subscription manager interface that is used by event sources.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

    com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

  • Method Summary

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

    Methods inherited from interface com.google.common.util.concurrent.Service

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

    Methods inherited from interface org.somda.sdc.dpws.soap.wseventing.SubscriptionManager

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

  • Method Details

    • offerNotification

      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

      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. This message is supposed to be a valid end-to message.

    • offerEndTo

      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

      void renew(Duration expires)
      Resets the expires duration.

      This will also affect SubscriptionManager.getExpiresTimeout().

      Parameters:
      expires - the duration to reset.

    • getCallerId

      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.