Module io.helidon.integrations.vault.sys
Package io.helidon.integrations.vault.sys

Interface Sys

  • public interface Sys
    Blocking APIs for Sys operations on Vault. Methods block the calling thread. DO NOT use this API in reactive environment, always use SysRx.

    This class is intended for use in blocking environments, such as CDI (where it can be injected) or in blocking server environment, where it can be obtained through create(SysRx).

    • Method Detail

      • create

        static Sys create​(SysRx reactiveSys)
        Create a new instance of blocking Vault Sys operations from the reactive instance. Handle with caution, as all methods on the returned instance block the calling thread, and as such are NOT SUITABLE FOR REACTIVE usage.
        Parameters:
        reactiveSys - reactive vault Sys operations, as obtained from Vault.sys(io.helidon.integrations.vault.SysApi)
        Returns:
        a new blocking Sys API

      • enableEngine

        default EnableEngine.Response enableEngine​(Engine<?> engine)
        Enable (mount) a secret engine on a default path.
        Parameters:
        engine - engine to enable
        Returns:
        when the engine is enabled

      • enableEngine

        EnableEngine.Response enableEngine​(EnableEngine.Request request)
        Enable (mount) a secret engine with custom configuration.
        Parameters:
        request - request for mount operation
        Returns:
        when the engine is enabled

      • disableEngine

        default DisableEngine.Response disableEngine​(Engine<?> engine)
        Disable (unmount) a secret engine from default path.
        Parameters:
        engine - to disable
        Returns:
        when the engine is disabled

      • disableEngine

        default DisableEngine.Response disableEngine​(String path)
        Disable (unmount) a secret engine from specific path.
        Parameters:
        path - mount path
        Returns:
        when the engine is disabled

      • enableAuth

        default EnableAuth.Response enableAuth​(AuthMethod<?> authMethod)
        Enable an authentication method on default path.
        Parameters:
        authMethod - authentication method to enable
        Returns:
        when the method is enabled

      • enableAuth

        EnableAuth.Response enableAuth​(EnableAuth.Request request)
        Enable an authentication method on custom path or with additional configuration.
        Parameters:
        request - mount request
        Returns:
        when the method is enabled

      • disableAuth

        default DisableAuth.Response disableAuth​(String path)
        Disable an authentication method.
        Parameters:
        path - path of the method
        Returns:
        when method is disabled

      • disableAuth

        DisableAuth.Response disableAuth​(DisableAuth.Request request)
        Disable an authentication method.
        Parameters:
        request - disable authentication method request
        Returns:
        disable authentication method response

      • createPolicy

        default CreatePolicy.Response createPolicy​(String name,
                                           String policy)
        Create a policy.
        Parameters:
        name - name of the policy
        policy - policy document
        Returns:
        when policy is created

      • deletePolicy

        default DeletePolicy.Response deletePolicy​(String name)
        Delete a policy.
        Parameters:
        name - name of the policy
        Returns:
        when policy is deleted