Package org.alfresco.event.gateway.subscription

Interface EventSubscriptionService

public interface EventSubscriptionService
Service in charge of dealing with the internal logic of the gateway

  • Method Details

    • getSubscription

      Subscription getSubscription(String subscriptionId)
      Fetches a given Subscription based on Id
      Parameters:
      subscriptionId - the id of the Subscription to be returned
      Returns:
      a Subscription with the subscription configuration of a given client application

    • createSubscription

      Subscription createSubscription(Subscription subscription)
      Creates a Subscription with the given configuration passed as a Subscription object
      Parameters:
      subscription - the configuration needed to create a Subscription
      Returns:
      the created Subscription

    • updateSubscription

      Subscription updateSubscription(Subscription subscription)
      Updates a Subscription item based on the subscription parameter
      Parameters:
      subscription - the new subscription information to be updated
      Returns:
      the updated Subscription object

    • refreshEventSubscription

      void refreshEventSubscription(String subscriptionId)
      Refreshes the EventSubscription instance corresponding to a subscription identifier.
      Parameters:
      subscriptionId - the identifier of the subscription to be refreshed

    • findSubscriptionsByUserAndFilterType

      List<Subscription> findSubscriptionsByUserAndFilterType(String user, String filterType)
      Find a list of Subscription filtered by the given username and containing at least one filter of a filter type
      Parameters:
      user - the username by which a Subscription is going to be filtered
      filterType - the type of filter to search for
      Returns:
      A list of Subscription matching with the requirements

    • findSubscriptionsByUserAndStatus

      List<Subscription> findSubscriptionsByUserAndStatus(String user, SubscriptionStatus subscriptionStatus)
      Find a list of Subscription filtered by the given user and SubscriptionStatus
      Parameters:
      user - the username by which a Subscription is going to be filtered
      subscriptionStatus - the subscription status to search for
      Returns:
      A list of Subscription matching with the requirements

    • unregisterEventSubscription

      void unregisterEventSubscription(String subscriptionId)
      Deregister the EventSubscription instance corresponding to a subscription identifier.
      Parameters:
      subscriptionId - the identifier of the subscription to be deregistered