Package oracle.webcenter.notification

Interface SubscriptionManager

@Exported public interface SubscriptionManager
Interface for creating and managing user subscriptions.

Based on these subscriptions, the notification service generates appropriate notifications for the activities occurring in the application. Notifications Service integrates with WebCenter Activity Streaming Service to generate notifications for services that contains activities supporting notifications.

Subscriptions can be created or enabled at application level, scope level and object level to control to receive notifications at the desired granularity.

  • At application level, subscriptions for services containing user targeted activities can be created.
  • At scope level, subscriptions for services provisioned within the given scope can be created. Typically these will involve 'create' activities within the services.
  • At object level, subscriptions to a specific resource (such as a document) can be created to receive granular notifications for a specific resouce.

    • In general, subscriptions can be created only for services and resources that support the specific level of subscriptions.

    See Also:

    • Method Details

      • isSubscribed

        boolean isSubscribed(String scopeGuid, String serviceId, String objectId) throws NotificationServiceException
        Checks if the current user has subscribed to the specific resource in the given scope.
        Parameters:
        scopeGuid - - the guid of the scope in which to check subscription.
        serviceId - - the service identifier for the resource.
        objectId - - the unique ID of the object to check the subscription for.
        Returns:
        - true, if the current user has subscribed to the given object, false otherwise.
        Throws:
        NotificationServiceException - - if the notification servie encounters any error.

      • getSubscriptionPreferences

        List<SubscriptionPreference> getSubscriptionPreferences() throws NotificationServiceException
        Returns the application level subscription preferences for the current user. This method returns a list of SubscriptionPreference for the current user for services that expose application level subscriptions. This method is also useful in retrieving the list of services that support application level subscriptions.
        Returns:
        list of SubscriptionPreference for the current user.
        Throws:
        NotificationServiceException - - if the notification servie encounters any error.

      • getSubscriptionPreferences

        List<SubscriptionPreference> getSubscriptionPreferences(String scopeGuid) throws NotificationServiceException
        Returns the scope level subscription preferences for the current user. This method returns a list of SubscriptionPreference for the current user for services that expose application level subscriptions and are provisioned in a given scope.
        Parameters:
        scopeGuid - - the GUID of the scope for which to return the user's subscription preferences.
        Returns:
        list of SubscriptionPreference for the current user in the given scope.
        Throws:
        NotificationServiceException - - if the notification servie encounters any error.

      • addSubcriptionPreference

        void addSubcriptionPreference(String serviceId) throws NotificationServiceException
        Enables the application level subscription preference for the current user for the given service. The service specified must support such subscription.
        Parameters:
        serviceId - - the sevrice identifier for which the current user's subscription will be enabled.
        Throws:
        NotificationServiceException - - if the notification service encounters any exception or if the specified service doesn't support application level subscriptions.

      • removeSubcriptionPreference

        void removeSubcriptionPreference(String serviceId) throws NotificationServiceException
        Disables the application level subscription preference for the current user for the given service, if exists.
        Parameters:
        serviceId - - the service identifier for which the current user's subscription will be disabled.
        Throws:
        NotificationServiceException - - if the notification servie encounters any error.

      • getSubscriptions

        List<Subscription> getSubscriptions(SortOption sortOption, FilterOption filterOption, int startIndex, int fetchSize) throws NotificationServiceException
        Returns the list of active subscriptions for the current user based on the specified criteria.

        The list returned does not contain user's application level subscription preferences. It returns all the scope level and object level subscriptions for the current users.

        Parameters:
        filterOption - - defines the filter criteria to fetch the subscriptions for the current user.
        sortOption - - the sort criteria for the list of returned subscriptions.
        startIndex - - the starting index for fetching the results.
        fetchSize - - the number of rows to be returned in the single fetch.
        Returns:
        list of Subscription objects for the current user matching the criteria specified.
        Throws:
        NotificationServiceException - - if the notification servie encounters any error.

      • subscribe

        Subscription subscribe(String scopeGuid, String serviceId) throws NotificationServiceException
        Creates a scope level subscription for the current user for the specified service in the given scope. The specified service must support scope level subscriptions.
        Parameters:
        scopeGuid - - GUID of the scope in which to create the subscription.
        serviceId - - the service identifier for which to create the subscription.
        Returns:
        - the newly created Subscription object.
        Throws:
        NotificationServiceException - - if the notification service encounters any exception.

      • subscribe

        Subscription subscribe(String scopeGuid, String serviceId, String objectType, String objectId, String objectName) throws NotificationServiceException
        Subscribes the current user for the given object.
        Parameters:
        scopeGuid - - GUID of the scope in which the object exists.
        serviceId - - indentifier of the service containing the object.
        objectType - - the type of the object to be subscribed to.
        objectId - - the unique identifier of the object as generated by the service.
        objectName - - the name of the object.
        Returns:
        - the newly created Subscription object.
        Throws:
        NotificationServiceException - - if the notification service encounters any exception.

      • unsubscribe

        void unsubscribe(String scopeGuid, String serviceId) throws NotificationServiceException
        Removes the scope level subscription for the current user for the specified service in the given scope, if exists.
        Parameters:
        scopeGuid - - GUID of the scope in which to create the subscription.
        serviceId - - the service identifier for which to delete the subscription.
        Throws:
        NotificationServiceException - - if the notification service encounters any exception.

      • unsubscribe

        void unsubscribe(String scopeGuid, String serviceId, String objectId) throws NotificationServiceException
        Unsubscribes the current user from the given object.
        Parameters:
        scopeGuid - - GUID of the scope in which the object exists.
        serviceId - - indentifier of the service containing the object.
        objectId - - the unique identifier of the object as generated by the service.
        Throws:
        NotificationServiceException - - if the notification service encounters any exception.