Packages

trait KeyManager extends AnyRef

A key manager handles the retrieval of API keys for use with, e.g. web APIs.

The key manager has multiple targets, each with a set of keys. A key can have a limited amount of calls it can be used for. The key manager handles refreshing of those number of calls.

Linear Supertypes
AnyRef, Any
Known Subclasses
StaticKeyManager, RedisKeyManager
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. KeyManager
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def request(target: String, numberOfCalls: Int): Option[ManagedKey]

    Request a key for given target with at least the number of calls given remaining.

    Request a key for given target with at least the number of calls given remaining.

    The number of calls will be used to count how many are still remaining.

    target

    Target of the key.

    numberOfCalls

    The number of calls needed on this key.

    returns

    A managed key.

Concrete Value Members

  1. def request(target: String): Option[ManagedKey]

    Request single-use key for given target.

    Request single-use key for given target.

    target

    Target of the key.

    returns

    A managed key.