Interface KeyReceiver

All Superinterfaces:
OsidReceiver
public interface KeyReceiver extends OsidReceiver

The key receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Key objects. A change to a key is a change to an Key .

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedKeys(Id notificationId, IdList keyIds)
    The callback for notification of updated keys.
    void
    deletedKeys(Id notificationId, IdList keyIds)
    the callback for notification of deleted keys.
    void
    newKeys(Id notificationId, IdList keyIds)
    The callback for notifications of new keys.

    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

    • newKeys

      void newKeys(Id notificationId, IdList keyIds)
      The callback for notifications of new keys.
      Parameters:
      notificationId - the notification Id
      keyIds - the Ids of the new Keys
      Compliance:
      mandatory - This method must be implemented.

    • changedKeys

      void changedKeys(Id notificationId, IdList keyIds)
      The callback for notification of updated keys.
      Parameters:
      notificationId - the notification Id
      keyIds - the Ids of the updated Keys
      Compliance:
      mandatory - This method must be implemented.

    • deletedKeys

      void deletedKeys(Id notificationId, IdList keyIds)
      the callback for notification of deleted keys.
      Parameters:
      notificationId - the notification Id
      keyIds - the Ids of the deleted Keys
      Compliance:
      mandatory - This method must be implemented.