Polishing.

Enhance JavaDoc.
This commit is contained in:
Mark Paluch
2016-09-24 22:03:50 +02:00
parent 19ea723649
commit a929a08d16
11 changed files with 21 additions and 13 deletions

View File

@@ -551,8 +551,7 @@
<docfilessubdirs>true</docfilessubdirs>
<additionalparam>-Xdoclint:none</additionalparam>
<links>
<link>http://docs.spring.io/spring/docs/4.2.x/javadoc-api/</link>
<link>http://docs.spring.io/spring-data/commons/docs/current/api/</link>
<link>http://docs.spring.io/spring/docs/current/javadoc-api/</link>
<link>http://docs.oracle.com/javase/6/docs/api</link>
</links>
</configuration>

View File

@@ -34,7 +34,6 @@ import org.springframework.vault.support.VaultToken;
* {@link VaultToken} from Vault's Cubbyhole secret backend. The login token is usually longer-lived and used to
* interact with Vault. The login token can be retrieved either from a wrapped response or from the {@code data}
* section.
* <p>
* <h2>Wrapped token response usage</h2> <strong>Create a Token</strong>
*
* <pre>

View File

@@ -306,7 +306,7 @@ public class VaultClient extends VaultAccessor {
*
* @param pathTemplate must not be empty or {@literal null}.
* @param uriVariables must not be {@literal null}.
* @return
* @return the resolved {@link URI}.
* @see org.springframework.web.util.UriComponentsBuilder
*/
protected URI buildUri(String pathTemplate, Map<String, ?> uriVariables) {

View File

@@ -117,7 +117,7 @@ public abstract class AbstractVaultConfiguration {
* Creates the {@link VaultClientFactory} to be used with {@link VaultTemplate}. Uses by default
* {@link DefaultVaultClientFactory} with the configured {@link #vaultClient()} instance.
*
* @return
* @return the {@link VaultClientFactory}.
*/
@Bean
public VaultClientFactory vaultClientFactory() {
@@ -127,7 +127,7 @@ public abstract class AbstractVaultConfiguration {
/**
* Creates a {@link VaultTemplate}.
*
* @return
* @return the {@link VaultTemplate}.
* @see #vaultClientFactory()
* @see #sessionManager()
*/

View File

@@ -39,9 +39,9 @@ import org.springframework.vault.support.VaultResponseSupport;
* {@link org.springframework.web.client.RestTemplate} level.
*
* @author Mark Paluch
* @see #doWithVault(ClientCallback)
* @see #doWithVault(SessionCallback)
* @see #doWithRestTemplate(String, Map, RestTemplateCallback)
* @see VaultOperations#doWithVault(ClientCallback)
* @see VaultOperations#doWithVault(SessionCallback)
* @see VaultOperations#doWithRestTemplate(String, Map, RestTemplateCallback)
* @see VaultClient
* @see VaultTemplate
* @see VaultTokenOperations
@@ -103,6 +103,7 @@ public interface VaultOperations {
* Write to a secret backend.
*
* @param path must not be {@literal null}.
* @param body the body, may be {@literal null} if absent.
* @return the configuration data. May be empty but never {@literal null}.
*/
VaultResponse write(String path, Object body);

View File

@@ -72,7 +72,7 @@ public interface VaultTransitOperations {
* of the key. To upgrade ciphertext to be encrypted with the latest version of the key, use
* {@link #rewrap(String, String)}.
*
* @param keyName
* @param keyName must not be empty or {@literal null}.
* @see #rewrap(String, String)
*/
void rotate(String keyName);

View File

@@ -70,6 +70,7 @@ public class SslConfiguration {
*
* @param trustStore resource pointing to an existing trust store, must not be {@literal null}.
* @param trustStorePassword may be {@literal null}.
* @return the created {@link SslConfiguration}.
* @see java.security.KeyStore
*/
public static SslConfiguration forTrustStore(Resource trustStore, String trustStorePassword) {
@@ -85,6 +86,7 @@ public class SslConfiguration {
*
* @param keyStore resource pointing to an existing key store, must not be {@literal null}.
* @param keyStorePassword may be {@literal null}.
* @return the created {@link SslConfiguration}.
* @see java.security.KeyStore
*/
public static SslConfiguration forKeyStore(Resource keyStore, String keyStorePassword) {
@@ -100,6 +102,9 @@ public class SslConfiguration {
*
* @param keyStore resource pointing to an existing keystore, must not be {@literal null}.
* @param keyStorePassword may be {@literal null}.
* @param trustStore resource pointing to an existing trust store, must not be {@literal null}.
* @param trustStorePassword may be {@literal null}.
* @return the created {@link SslConfiguration}.
* @see java.security.KeyStore
*/
public SslConfiguration create(Resource keyStore, String keyStorePassword, Resource trustStore,

View File

@@ -58,6 +58,7 @@ public class VaultMount {
* Creates a new {@link VaultMount} given a {@code type}.
*
* @param type backend type, must not be empty or {@literal null}.
* @return the created {@link VaultMount}.
*/
public static VaultMount create(String type) {
return builder().type(type).build();

View File

@@ -24,7 +24,7 @@ import com.fasterxml.jackson.annotation.JsonProperty;
/**
* Value object to bind generic Vault HTTP API responses.
*
* @param <T>
* @param <T> type for {@code data} response.
* @author Spencer Gibb
* @author Mark Paluch
*/

View File

@@ -51,6 +51,7 @@ public class VaultToken {
* Creates a new {@link VaultToken} with a {@code leaseDuration}.
*
* @param token must not be {@literal null}.
* @param leaseDuration the lease duration.
* @return the created {@link VaultToken}
*/
public static VaultToken of(String token, long leaseDuration) {

View File

@@ -37,10 +37,12 @@ public class VaultTransitKeyCreationRequest {
* Creates a new {@link VaultTransitKeyCreationRequest} and sets {@code derived} and {@code convergentEncryption}
* properties.
*
* @param derived
* @param convergentEncryption
* @param derived {@literal true} if key derivation MUST be used.
* @param convergentEncryption {@literal true} if key will support convergent encryption, where the same plaintext
* creates the same ciphertext.
*/
public VaultTransitKeyCreationRequest(boolean derived, boolean convergentEncryption) {
this.derived = derived;
this.convergentEncryption = convergentEncryption;
}