Polishing.
This commit is contained in:
@@ -22,13 +22,13 @@ import java.lang.annotation.Retention;
|
||||
import java.lang.annotation.RetentionPolicy;
|
||||
import java.lang.annotation.Target;
|
||||
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.Import;
|
||||
|
||||
/**
|
||||
* Annotation providing a convenient and declarative mechanism for adding a
|
||||
* {@link VaultPropertySource} to Spring's {@link org.springframework.core.env.Environment
|
||||
* Environment}. To be used in conjunction with @{@link Configuration} classes.
|
||||
* Environment}. To be used in conjunction with
|
||||
* {@link org.springframework.context.annotation.Configuration @Configuration} classes.
|
||||
* <h3>Example usage</h3>
|
||||
* <p>
|
||||
* Given a Vault path {@code secret/my-application} containing the configuration data pair
|
||||
@@ -64,9 +64,8 @@ import org.springframework.context.annotation.Import;
|
||||
* the {@code @Configuration} classes above were registered via component-scanning, the
|
||||
* ordering is difficult to predict. In such cases - and if overriding is important - it
|
||||
* is recommended that the user fall back to using the programmatic PropertySource API.
|
||||
* See {@link org.springframework.core.env.ConfigurableEnvironment
|
||||
* ConfigurableEnvironment} and {@link org.springframework.core.env.MutablePropertySources
|
||||
* MutablePropertySources} javadocs for details.
|
||||
* See {@link org.springframework.core.env.ConfigurableEnvironment} and
|
||||
* {@link org.springframework.core.env.MutablePropertySources} javadocs for details.
|
||||
*
|
||||
* @author Mark Paluch
|
||||
* @see org.springframework.vault.core.env.VaultPropertySource
|
||||
|
||||
@@ -30,21 +30,21 @@ import org.springframework.web.reactive.function.client.WebClientException;
|
||||
|
||||
/**
|
||||
* Interface that specifies a basic set of Vault operations executed on a reactive
|
||||
* infrastructure, implemented by {@link ReactiveVaultTemplate}. This is the main entry
|
||||
* infrastructure, implemented by
|
||||
* {@link org.springframework.vault.core.ReactiveVaultTemplate}. This is the main entry
|
||||
* point to interact with Vault in an authenticated and unauthenticated context.
|
||||
* <p>
|
||||
* {@link ReactiveVaultOperations} allows execution of callback methods. Callbacks can
|
||||
* execute requests within a {@link ReactiveVaultOperations#doWithSession(Function)
|
||||
* session context} and the {@link ReactiveVaultOperations#doWithVault(Function) without a
|
||||
* session}.
|
||||
* execute requests within a {@link #doWithSession(Function) session context} and the
|
||||
* {@link #doWithVault(Function) without a session}.
|
||||
*
|
||||
* @author Mark Paluch
|
||||
* @since 2.0
|
||||
* @see ReactiveVaultOperations#doWithSession(Function)
|
||||
* @see ReactiveVaultOperations#doWithVault(Function)
|
||||
* @see WebClient
|
||||
* @see VaultTemplate
|
||||
* @see VaultTokenOperations
|
||||
* @see #doWithSession(Function)
|
||||
* @see #doWithVault(Function)
|
||||
* @see org.springframework.web.reactive.function.client.WebClient
|
||||
* @see org.springframework.vault.core.VaultTemplate
|
||||
* @see org.springframework.vault.core.VaultTokenOperations
|
||||
* @see org.springframework.vault.authentication.VaultTokenSupplier
|
||||
*/
|
||||
public interface ReactiveVaultOperations {
|
||||
|
||||
@@ -26,20 +26,19 @@ import org.springframework.web.client.RestClientException;
|
||||
|
||||
/**
|
||||
* Interface that specifies a basic set of Vault operations, implemented by
|
||||
* {@link VaultTemplate}. This is the main entry point to interact with Vault in an
|
||||
* authenticated and unauthenticated context.
|
||||
* {@link org.springframework.vault.core.VaultTemplate}. This is the main entry point to
|
||||
* interact with Vault in an authenticated and unauthenticated context.
|
||||
* <p>
|
||||
* {@link VaultOperations} allows execution of callback methods. Callbacks can execute
|
||||
* requests within a {@link VaultOperations#doWithSession(RestOperationsCallback) session
|
||||
* context} and the {@link VaultOperations#doWithVault(RestOperationsCallback) without a
|
||||
* session}.
|
||||
* requests within a {@link #doWithSession(RestOperationsCallback) session context} and
|
||||
* the {@link #doWithVault(RestOperationsCallback) without a session}.
|
||||
*
|
||||
* @author Mark Paluch
|
||||
* @see VaultOperations#doWithSession(RestOperationsCallback)
|
||||
* @see VaultOperations#doWithVault(RestOperationsCallback)
|
||||
* @see #doWithSession(RestOperationsCallback)
|
||||
* @see #doWithVault(RestOperationsCallback)
|
||||
* @see org.springframework.web.client.RestOperations
|
||||
* @see VaultTemplate
|
||||
* @see VaultTokenOperations
|
||||
* @see org.springframework.vault.core.VaultTemplate
|
||||
* @see org.springframework.vault.core.VaultTokenOperations
|
||||
* @see org.springframework.vault.authentication.SessionManager
|
||||
*/
|
||||
public interface VaultOperations {
|
||||
|
||||
@@ -16,14 +16,13 @@
|
||||
package org.springframework.vault.core.env;
|
||||
|
||||
import org.springframework.vault.VaultException;
|
||||
import org.springframework.vault.annotation.VaultPropertySource;
|
||||
|
||||
/**
|
||||
* Exception throws when a {@code VaultPropertySource} could not load its properties.
|
||||
*
|
||||
* @author Mark Paluch
|
||||
* @since 2.2
|
||||
* @see VaultPropertySource#ignoreSecretNotFound
|
||||
* @see org.springframework.vault.annotation.VaultPropertySource#ignoreSecretNotFound
|
||||
*/
|
||||
public class VaultPropertySourceNotFoundException extends VaultException {
|
||||
|
||||
|
||||
@@ -27,7 +27,8 @@ import org.springframework.vault.support.VaultResponse;
|
||||
* Vault database exchange object containing data before/after it's exchanged with Vault.
|
||||
* A {@link SecretDocument} is basically an object with an {@code id} and a body
|
||||
* represented as {@link Map} of {@link String} and {@link Object}. It can be created
|
||||
* {@link #from(String, VaultResponse) from} an Id and {@link VaultResponse}.
|
||||
* {@link #from(String, VaultResponse) from} an Id and
|
||||
* {@link org.springframework.vault.support.VaultResponse}.
|
||||
* <p>
|
||||
* A secret document can hold simple properties, {@link java.util.Collection list}
|
||||
* properties and nested objects as {@link Map}s.
|
||||
|
||||
Reference in New Issue
Block a user