Enum Class AbstractVaultProviderFactory.AvailableResolvers

All Implemented Interfaces:
Serializable, Comparable<AbstractVaultProviderFactory.AvailableResolvers>, Constable
Enclosing class:

protected static enum AbstractVaultProviderFactory.AvailableResolvers extends Enum<AbstractVaultProviderFactory.AvailableResolvers>
Enum containing the available VaultKeyResolvers. The name used in the factory configuration must match the name one of the enum members.
  • Enum Constant Details

    • KEY_ONLY

      Ignores the realm, only the vault key is used when retrieving a secret from the vault. This is useful when we want all realms to share the secrets, so instead of replicating entries for all existing realms in the vault one can simply use key directly and all realms will obtain the same secret.

      public static final AbstractVaultProviderFactory.AvailableResolvers REALM_UNDERSCORE_KEY
      The realm is prepended to the vault key and they are separated by an underscore ('_') character. If either the realm or the key contains an underscore, it is escaped by another underscore character.

      public static final AbstractVaultProviderFactory.AvailableResolvers REALM_FILESEPARATOR_KEY
      The realm is prepended to the vault key and they are separated by the platform file separator character. Not all providers might support this format but it is useful when a directory structure is used to group secrets per realm.

      public static final AbstractVaultProviderFactory.AvailableResolvers FACTORY_PROVIDED
      The format of the vault key is determined by the factory's getFactoryResolver implementation. This allows for the customization of the vault key format by extending the factory and overriding the getFactoryResolver method. It is instantiated with a null resolver because we can't access the factory from the enum's static context.
  • Method Details

    • values

      Returns an array containing the constants of this enum class, in the order they are declared.
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null