Interface AvailabilityEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to AvailabilityEnabler objects in this Foundry . This also includes existing AvailabilityEnablers that may appear or disappear due to changes in the Foundry hierarchy, 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.

The two views defined in this session correspond to the views in the AvailabilityEnablerLookupSession .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canRegisterForAvailabilityEnablerNotifications

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

    • useFederatedFoundryView

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

    • useIsolatedFoundryView

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

    • reliableAvailabilityEnablerNotifications

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

    • unreliableAvailabilityEnablerNotifications

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

    • acknowledgeAvailabilityEnablerNotification

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

    • registerForNewAvailabilityEnablers

      void registerForNewAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new availability enablers. AvailabilityEnablerReceiver.newAvailabilityEnablers() is invoked when a new AvailabilityEnabler appears in this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAvailabilityEnablers

      void registerForChangedAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated foundries. AvailabilityEnablerReceiver.changedAvailabilityEnablers() is invoked when an availability enabler in this foundry is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAvailabilityEnabler

      void registerForChangedAvailabilityEnabler(Id availabilityEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated availability enabler. ProvisionableReceiver.changedAvailabilityEnablers() is invoked when the specified availability enabler in this foundry is changed.
      Parameters:
      availabilityEnablerId - the Id of the AvailabilityEnabler to monitor
      Throws:
      NullArgumentException - availabilityEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAvailabilityEnablers

      void registerForDeletedAvailabilityEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted availability enablers. AvailabilityEnablerReceiver.deletedAvailabilityEnablers() is invoked when an availability enabler is deleted or removed from this foundry.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAvailabilityEnabler

      void registerForDeletedAvailabilityEnabler(Id availabilityEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted availability enabler. AvailabilityEnablerReceiver.deletedAvailabilityEnablers() is invoked when the specified availability enabler is deleted or removed from this foundry.
      Parameters:
      availabilityEnablerId - the Id of the AvailabilityEnabler to monitor
      Throws:
      NullArgumentException - availabilityEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.