Interface RepositoryNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RepositoryNotificationSession extends OsidSession

This session defines methods to receive notifications on adds/changes to Repository objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed.

  • Method Details

    • canRegisterForRepositoryNotifications

      boolean canRegisterForRepositoryNotifications()
      Tests if this user can register for Repository notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer notification operations.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • reliableRepositoryNotifications

      void reliableRepositoryNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeRepositoryNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableRepositoryNotifications

      void unreliableRepositoryNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeRepositoryNotification

      void acknowledgeRepositoryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a repository notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRepositories

      void registerForNewRepositories() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new repositories. RepositoryReceiver.newRepositories() is invoked when a new Repository is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRepositories

      void registerForChangedRepositories() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated repositories. RepositoryReceiver.changedRepositories() is invoked when a repository is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRepository

      void registerForChangedRepository(Id repositoryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated repository. RepositoryReceiver.changedRepositories() is invoked when the specified repository is changed.
      Parameters:
      repositoryId - the Id of the Repository to monitor
      Throws:
      NullArgumentException - repositoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRepositories

      void registerForDeletedRepositories() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted repositories. RepositoryReceiver.deletedRepositories() is invoked when a repository is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRepository

      void registerForDeletedRepository(Id repositoryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted repository. RepositoryReceiver.deletedRepositories() is invoked when the specified repository is deleted.
      Parameters:
      repositoryId - the Id of the Repository to monitor
      Throws:
      NullArgumentException - repositoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRepositoryHierarchy

      void registerForChangedRepositoryHierarchy() throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated repository hierarchy structure. RepositoryReceiver.changedChildOfRepositoriess() is invoked when the specified node or any of its descendants experiences a change in its children.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRepositoryHierarchyForAncestors

      void registerForChangedRepositoryHierarchyForAncestors(Id repositoryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated repository hierarchy structure. RepositoryReceiver.changedChildOfRepositoriess() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      repositoryId - the Id of the Repository node to monitor
      Throws:
      NullArgumentException - repositoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRepositoryHierarchyForDescendants

      void registerForChangedRepositoryHierarchyForDescendants(Id repositoryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated repository hierarchy structure. RepositoryReceiver.changedChildOfRepositoriess() is invoked when the specified node or any of its descendants experiences a change in its children.
      Parameters:
      repositoryId - the Id of the Repository node to monitor
      Throws:
      NullArgumentException - repositoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.