Interface EdgeEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to EdgeEnabler objects in this Graph . This also includes existing EdgeEnablers that may appear or disappear due to changes in the Graph 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 EdgeEnablerLookupSession .

  • Method Details

    • getGraphId

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

    • getGraph

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

    • canRegisterForEdgeEnablerNotifications

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

    • useFederatedGraphView

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

    • useIsolatedGraphView

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

    • reliableEdgeEnablerNotifications

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

    • unreliableEdgeEnablerNotifications

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

    • acknowledgeEdgeEnablerNotification

      void acknowledgeEdgeEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an edge 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.

    • registerForNewEdgeEnablers

      void registerForNewEdgeEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new edge enablers. EdgeEnablerReceiver.newEdgeEnablers() is invoked when a new EdgeEnabler appears in this graph.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEdgeEnablers

      void registerForChangedEdgeEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated graph enabelrs. EdgeEnablerReceiver.changedEdgeEnablers() is invoked when an edge enabler in this graph is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEdgeEnabler

      void registerForChangedEdgeEnabler(Id edgeEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated edge enabler. ProvisionableReceiver.changedEdgeEnablers() is invoked when the specified edge enabler in this graph is changed.
      Parameters:
      edgeEnablerId - the Id of the EdgeEnabler to monitor
      Throws:
      NullArgumentException - edgeEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEdgeEnablers

      void registerForDeletedEdgeEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted edge enablers. EdgeEnablerReceiver.deletedEdgeEnablers() is invoked when an edge enabler is deleted or removed from this graph.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEdgeEnabler

      void registerForDeletedEdgeEnabler(Id edgeEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted edge enabler. EdgeEnablerReceiver.deletedEdgeEnablers() is invoked when the specified edge enabler is deleted or removed from this graph.
      Parameters:
      edgeEnablerId - the Id of the EdgeEnabler to monitor
      Throws:
      NullArgumentException - edgeEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.