Interface TriggerNotificationSession

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

This session defines methods to receive notifications on adds/changes to Triggers in this System . This also includes existing triggers that may appear or disappear due to changes in the System 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 TriggerLookupSession .

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canRegisterForTriggerNotifications

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

    • useFederatedSystemView

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

    • useIsolatedSystemView

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

    • reliableTriggerNotifications

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

    • unreliableTriggerNotifications

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

    • acknowledgeTriggerNotification

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

    • registerForNewTriggers

      void registerForNewTriggers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new triggers. TriggerReceiver.newTriggesr() is invoked when a new Trigger appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewTriggersForController

      void registerForNewTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of new triggers for the given controller. TriggerReceiver.newTriggers() is invoked a new Trigger appears in this system.
      Parameters:
      controllerId - the Id of the Controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTriggers

      void registerForChangedTriggers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated triggers. TriggerReceiver.changedTriggers() is invoked when a trigger in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTriggersForController

      void registerForChangedTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated triggers for the given controller. TriggerReceiver.changedTriggers() is invoked when the specified trigger in this system is changed.
      Parameters:
      controllerId - the Id of the Controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTrigger

      void registerForChangedTrigger(Id triggerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated trigger. TriggerReceiver.changedTriggers() is invoked when the specified trigger in this system is changed.
      Parameters:
      triggerId - the Id of the Trigger to monitor
      Throws:
      NullArgumentException - triggerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTriggers

      void registerForDeletedTriggers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted triggers. TriggerReceiver.deletedTriggers() is invoked when a trigger is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTriggersForController

      void registerForDeletedTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted triggers for the given controller. TriggerReceiver.deletedTrigger() is invoked when the specified trigger is deleted or removed from this system.
      Parameters:
      controllerId - the Id of the Controller to monitor
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTrigger

      void registerForDeletedTrigger(Id triggerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted trigger. TriggerReceiver.deletedTriggers() is invoked when the specified trigger is deleted or removed from this system.
      Parameters:
      triggerId - the Id of the Trigger to monitor
      Throws:
      NullArgumentException - triggerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.