Interface GroupNotificationSession

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

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

    • getBinId

      Id getBinId()
      Gets the Bin Id associated with this session.
      Returns:
      the Bin Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getBin

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

    • canRegisterForGroupNotifications

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

    • useFederatedBinView

      void useFederatedBinView()
      Federates the view for methods in this session. A federated view will include resources in bins which are children of this bin in the bin hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBinView

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

    • reliableGroupNotifications

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

    • unreliableGroupNotifications

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

    • acknowledgeGroupNotification

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

    • registerForNewMembers

      void registerForNewMembers(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of new resource memberss. GroupReceiver.newMember() is invoked when a new member is added to the specified group.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedMembers

      void registerForDeletedMembers(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of deleted resource memberss. GroupReceiver.deletedMember() is invoked when a new member is removed from the specified group.
      Parameters:
      resourceId - the Id of the Resource to monitor
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.