Interface DirectoryNotificationSession

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

This session defines methods to receive notifications on adds/changes to Directories . 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.

Two view are defined in this session:

federated view: includes notifications of directories located in descendants of this directory

isolated view: includes notifcations of directories in this directory only

  • Method Details

    • getDirectoryId

      Id getDirectoryId()
      Gets the Id of this directory.
      Returns:
      the Id of this directory
      Compliance:
      mandatory - This method must be implemented.

    • getDirectory

      Directory getDirectory() throws OperationFailedException, PermissionDeniedException
      Gets the Directory associated with this session.
      Returns:
      the Directory associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForDirectoryNotifications

      boolean canRegisterForDirectoryNotifications()
      Tests if this user can register for Directory 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.

    • useFederatedDirectoryView

      void useFederatedDirectoryView()
      Federates the view for methods in this session. A federated view will include directories in directories which are children of this directory.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedDirectoryView

      void useIsolatedDirectoryView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this diretory only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableDirectoryNotifications

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

    • unreliableDirectoryNotifications

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

    • acknowledgeDirectoryNotification

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

    • registerForNewDirectories

      void registerForNewDirectories() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new directories. DirectoryReceiver.newDirectories() is invoked when a new Directory is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDirectories

      void registerForChangedDirectories() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated directories. DirectoryReceiver.changedDirectories() is invoked when a file is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDirectory

      void registerForChangedDirectory(Id directoryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated file. DirectoryReceiver.changedDirectories() is invoked when the specified directory is changed.
      Parameters:
      directoryId - the Id of the directory to monitor
      Throws:
      NullArgumentException - directoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDirectories

      void registerForDeletedDirectories() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted directories. DirectoryReceiver.deletedDirectories() is invoked when a directory is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDirectory

      void registerForDeletedDirectory(Id directoryId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted directory. DirectoryReceiver.changedDirectories() is invoked when the specified directory is deleted.
      Parameters:
      directoryId - the Id of the directory to monitor
      Throws:
      NullArgumentException - directoryId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.