Interface Engine<T extends SecretsRx>

  • Type Parameters:
    T - type of the Secret provided by the engine

    public interface Engine<T extends SecretsRx>
    A secrets engine. Supported built-in engines are available as constants.
    • Method Detail

      • create

        static <T extends SecretsRxEngine<T> create​(Class<T> secrets,
                                                      String type,
                                                      String defaultMount,
                                                      String version)
        Create a new versioned engine.
        Type Parameters:
        T - type of secrets
        Parameters:
        secrets - secrets class
        type - type of engine
        defaultMount - default path to mount this engine on
        version - version of engine
        Returns:
        a new engine
      • create

        static <T extends SecretsRxEngine<T> create​(Class<T> secrets,
                                                      String type,
                                                      String defaultMount)
        Create an engine.
        Type Parameters:
        T - type of secrets
        Parameters:
        secrets - secrets class
        type - type of engine
        defaultMount - default path to mount this engine on
        Returns:
        a new engine
      • type

        String type()
        Type of the engine as used in the REST API.
        Returns:
        type of the engine, such as kv
      • version

        Optional<String> version()
        Version of the engine if versioned.
        Returns:
        version of the engine (such as 1 or 2 for KV engines)
      • defaultMount

        String defaultMount()
        Default path to mount this engine on.
        Returns:
        default mount path