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

Interface ParticipantContextStore

public interface ParticipantContextStore
Stores ParticipantContext objects and provides basic CRUD operations.

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    alreadyExistsErrorMessage(String id)
     
    org.eclipse.edc.spi.result.StoreResult<Void>
    create(org.eclipse.edc.identityhub.spi.participantcontext.model.ParticipantContext context)
    Creates a ParticipantContext resource in the store.
    org.eclipse.edc.spi.result.StoreResult<Void>
    deleteById(String id)
    Deletes a ParticipantContext resource from the store based on the given ID.
    default String
    notFoundErrorMessage(String id)
     
    org.eclipse.edc.spi.result.StoreResult<Collection<org.eclipse.edc.identityhub.spi.participantcontext.model.ParticipantContext>>
    query(org.eclipse.edc.spi.query.QuerySpec querySpec)
    Queries the store for ParticipantContexts based on the given query specification.
    org.eclipse.edc.spi.result.StoreResult<Void>
    update(org.eclipse.edc.identityhub.spi.participantcontext.model.ParticipantContext participantContext)
    Updates a ParticipantContext resource in the store.

  • Method Details

    • create

      org.eclipse.edc.spi.result.StoreResult<Void> create(org.eclipse.edc.identityhub.spi.participantcontext.model.ParticipantContext context)
      Creates a ParticipantContext resource in the store.
      Parameters:
      context - The ParticipantContext resource to create.
      Returns:
      success if not exists, a failure if already exists

    • query

      org.eclipse.edc.spi.result.StoreResult<Collection<org.eclipse.edc.identityhub.spi.participantcontext.model.ParticipantContext>> query(org.eclipse.edc.spi.query.QuerySpec querySpec)
      Queries the store for ParticipantContexts based on the given query specification.
      Parameters:
      querySpec - The QuerySpec indicating the criteria for the query.
      Returns:
      A StoreResult object containing a list of ParticipantContext objects that match the query. If none are found, returns an empty stream.

    • update

      org.eclipse.edc.spi.result.StoreResult<Void> update(org.eclipse.edc.identityhub.spi.participantcontext.model.ParticipantContext participantContext)
      Updates a ParticipantContext resource in the store.
      Parameters:
      participantContext - The ParticipantContext resource to update. Note that all fields are overwritten.
      Returns:
      success if participant context exists, failure otherwise

    • deleteById

      org.eclipse.edc.spi.result.StoreResult<Void> deleteById(String id)
      Deletes a ParticipantContext resource from the store based on the given ID.
      Parameters:
      id - The ID of the ParticipantContext resource to delete.
      Returns:
      success if the object could be deleted, a failure otherwise

    • alreadyExistsErrorMessage

      default String alreadyExistsErrorMessage(String id)

    • notFoundErrorMessage

      default String notFoundErrorMessage(String id)