Interface LeasingSecretBackendMetadata

All Superinterfaces:
SecretBackendMetadata
public interface LeasingSecretBackendMetadata extends SecretBackendMetadata
Lease extension to SecretBackendMetadata providing a lease mode.
Since:
1.1
Author:
Mark Paluch
See Also:
  • RequestedSecret

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    afterRegistration(org.springframework.vault.core.lease.domain.RequestedSecret secret, org.springframework.vault.core.lease.SecretLeaseContainer container)
    Callback method after registering a secret with SecretLeaseContainer.
    default void
    beforeRegistration(org.springframework.vault.core.lease.domain.RequestedSecret secret, org.springframework.vault.core.lease.SecretLeaseContainer container)
    Callback method before registering a secret with SecretLeaseContainer.
    org.springframework.vault.core.lease.domain.RequestedSecret.Mode
    getLeaseMode()
    Return the lease mode of this secret backend.

    Methods inherited from interface SecretBackendMetadata

    getName, getPath, getPropertyTransformer, getVariables

  • Method Details

    • getLeaseMode

      org.springframework.vault.core.lease.domain.RequestedSecret.Mode getLeaseMode()
      Return the lease mode of this secret backend.

      Lease mode is considered only by lease-aware property sources.

      Returns:
      the lease mode of this secret backend.
      Since:
      1.1

    • beforeRegistration

      default void beforeRegistration(org.springframework.vault.core.lease.domain.RequestedSecret secret, org.springframework.vault.core.lease.SecretLeaseContainer container)
      Callback method before registering a secret with SecretLeaseContainer. Registering a before callback allows event consumption before the secrets are visible in the associated property source.
      Parameters:
      secret - the requested secret.
      container - the lease container that was used to request the secret.
      Since:
      3.0

    • afterRegistration

      default void afterRegistration(org.springframework.vault.core.lease.domain.RequestedSecret secret, org.springframework.vault.core.lease.SecretLeaseContainer container)
      Callback method after registering a secret with SecretLeaseContainer. Registering a after callback allows event consumption after the secrets are visible in the associated property source. Note that this callback does not necessarily guarantee notification of the initial secrets retrieval.
      Parameters:
      secret - the requested secret.
      container - the lease container that was used to request the secret.
      Since:
      3.0