Interface FileNotificationSession

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

This session defines methods to receive notifications on adds/changes to Files . 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 files located in subdirectories in this directory

isolated view: includes notifcations of files 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.

    • canRegisterForFileNotifications

      boolean canRegisterForFileNotifications()
      Tests if this user can register for File 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 files 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.

    • reliableFileNotifications

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

    • unreliableFileNotifications

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

    • acknowledgeFileNotification

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

    • registerForNewFiles

      void registerForNewFiles() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new files. FileReceiver.newFiles() is invoked when a new File is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedFiles

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

    • registerForChangedFile

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

    • registerForDeletedFiles

      void registerForDeletedFiles() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted files. FileReceiver.deletedFiles() is invoked when a file is deleted.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedFile

      void registerForDeletedFile(Id fileId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted file. FileReceiver.changedFiles() is invoked when the specified file is deleted.
      Parameters:
      fileId - the Id of the file
      Throws:
      NullArgumentException - fileId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.