Package io.gravitee.gateway.api.service

Interface ApiKeyService

public interface ApiKeyService
This manages api keys.

  • Method Details

    • register

      void register(ApiKey apiKey)
      Register the given api key. Will load it if active, or unload it otherwise.
      Parameters:
      apiKey - the api key to register

    • unregister

      void unregister(ApiKey apiKey)

    • unregisterByApiId

      void unregisterByApiId(String apiId)
      Unregister all api key from the given api id.
      Parameters:
      apiId - the api id attached to apikeys to unregister

    • getByApiAndKey

      Optional<ApiKey> getByApiAndKey(String api, String key)
      Get api key by its api and key.
      Parameters:
      api - Searched api
      key - Searched key
      Returns:
      Found ApiKey

    • getByApiAndMd5Key

      Optional<ApiKey> getByApiAndMd5Key(String api, String md5ApiKey)
      Get api key by its api and md5 hash of the key.
      Parameters:
      api - Searched api
      md5ApiKey - Searched md5 hash of the key
      Returns:
      Found ApiKey