Interface EndpointReceiver

All Superinterfaces:
OsidReceiver
public interface EndpointReceiver extends OsidReceiver

The endpoint receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Endpoint objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedChildOfEndpoints(Id notificationId, IdList endpointIds)
    The callback for notifications of changes to children of endpoint hierarchy nodes.
    void
    changedEndpoints(Id notificationId, IdList endpointIds)
    The callback for notification of updated endpoints.
    void
    deletedEndpoints(Id notificationId, IdList endpointIds)
    The callback for notification of deleted endpoints.
    void
    newEndpoints(Id notificationId, IdList endpointIds)
    The callback for notifications of new endpoints.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newEndpoints

      void newEndpoints(Id notificationId, IdList endpointIds)
      The callback for notifications of new endpoints.
      Parameters:
      notificationId - the notification Id
      endpointIds - the Ids of the new Endpoints
      Compliance:
      mandatory - This method must be implemented.

    • changedEndpoints

      void changedEndpoints(Id notificationId, IdList endpointIds)
      The callback for notification of updated endpoints.
      Parameters:
      notificationId - the notification Id
      endpointIds - the Ids of the updated Endpoints
      Compliance:
      mandatory - This method must be implemented.

    • deletedEndpoints

      void deletedEndpoints(Id notificationId, IdList endpointIds)
      The callback for notification of deleted endpoints.
      Parameters:
      notificationId - the notification Id
      endpointIds - the Ids of the deleted Endpoints
      Compliance:
      mandatory - This method must be implemented.

    • changedChildOfEndpoints

      void changedChildOfEndpoints(Id notificationId, IdList endpointIds)
      The callback for notifications of changes to children of endpoint hierarchy nodes.
      Parameters:
      notificationId - the notification Id
      endpointIds - the Ids of the Endpoints whose children have changed
      Compliance:
      mandatory - This method must be implemented.