Package org.eclipse.edc.identityhub.spi.store

Interface KeyPairResourceStore

public interface KeyPairResourceStore
Stores KeyPairResource entities in persistent storage.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.edc.spi.result.StoreResult<Void>
    create(org.eclipse.edc.identityhub.spi.keypair.model.KeyPairResource keyPairResource)
    Create a new entry in the database using the data specified.
    org.eclipse.edc.spi.result.StoreResult<Void>
    deleteById(String id)
    Deletes a KeyPairResource with the given ID, if it exists.
    org.eclipse.edc.spi.result.StoreResult<Collection<org.eclipse.edc.identityhub.spi.keypair.model.KeyPairResource>>
    query(org.eclipse.edc.spi.query.QuerySpec query)
    Searches for KeyPairResources using the given QuerySpec.
    org.eclipse.edc.spi.result.StoreResult<Void>
    update(org.eclipse.edc.identityhub.spi.keypair.model.KeyPairResource keyPairResource)
    Updates a given KeyPairResource.

  • Method Details

    • create

      org.eclipse.edc.spi.result.StoreResult<Void> create(org.eclipse.edc.identityhub.spi.keypair.model.KeyPairResource keyPairResource)
      Create a new entry in the database using the data specified.
      Parameters:
      keyPairResource - the new KeyPairResource. Must not already exist.
      Returns:
      failure if a KeyPairResource with the same ID already exists.

    • query

      org.eclipse.edc.spi.result.StoreResult<Collection<org.eclipse.edc.identityhub.spi.keypair.model.KeyPairResource>> query(org.eclipse.edc.spi.query.QuerySpec query)
      Searches for KeyPairResources using the given QuerySpec.
      Parameters:
      query - the query
      Returns:
      A (potentially) empty collection of key pair resources, never null.

    • update

      org.eclipse.edc.spi.result.StoreResult<Void> update(org.eclipse.edc.identityhub.spi.keypair.model.KeyPairResource keyPairResource)
      Updates a given KeyPairResource.
      Parameters:
      keyPairResource - The updated KeyPairResource. Will overwrite existing data in the database.
      Returns:
      failure if a KeyPairResource with the same ID does not yet exist.

    • deleteById

      org.eclipse.edc.spi.result.StoreResult<Void> deleteById(String id)
      Deletes a KeyPairResource with the given ID, if it exists.
      Parameters:
      id - The id of the KeyPairResource to delete
      Returns:
      failure if the specified KeyPairResource does not exist.