org.kiwiproject.ansible.vault.VaultConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kiwi Show documentation

Kiwi is a utility library. We really like Google's Guava, and also use Apache Commons. But if they don't have something we need, and we think it is useful, this is where we put it.

There is a newer version: 4.5.2

Show newest version

package org.kiwiproject.ansible.vault;

import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.kiwiproject.base.KiwiPreconditions.requireNotBlank;

import lombok.Builder;
import lombok.Getter;
import lombok.Setter;

import javax.validation.constraints.NotBlank;

/**
 * Configuration class for creating ansible-vault commands. Can be constructed via the no-arg constructor, the all-args
 * constructor, or the builder. The builder is the preferred way to create an instance if done programmatically.
 * 
 * This is mutable in case it is used in injected configuration, e.g. in a Dropwizard configuration file.
 * 

 * Has beans validation annotations to support validation of external configuration, e.g. by Dropwizard's
 * normal validation. But also uses explicit validation in the all-args constructor used for the Lombok builder so
 * that invalid configurations cannot be constructed via the builder.
 */
@Getter
@Setter
public class VaultConfiguration {

    /**
     * Path to the ansible-vault executable.
     */
    @NotBlank
    private String ansibleVaultPath;

    /**
     * Path to the file containing passwords to use when encrypting and decrypting with ansible-vault.
     */
    @NotBlank
    private String vaultPasswordFilePath;

    /**
     * A temporary directory that is used to store encrypted content when decrypting string variables via
     * the {@code ansible-vault encrypt_string} command.
     */
    @NotBlank
    private String tempDirectory;

    /**
     * No-arg constructor. Useful mainly when using an external configuration mechanism that uses setter methods.
     * 

     * Sets the temporary directory to the value of the running JVM's {@code java.io.tmpdir} system property.
     */
    public VaultConfiguration() {
        this.tempDirectory = getJavaTempDir();
    }

    /**
     * All-args constructor.
     * 
     * If {@code tempDirectory} is blank, the temporary directory will be set to the value of the running JVM's
     * {@code java.io.tmpdir} system property.
     *
     * @param ansibleVaultPath      path to the ansible-vault executable
     * @param vaultPasswordFilePath path to the vault password file for encryption
     * @param tempDirectory         a temporary directory used with the {@code encrypt_string} command
     * @implNote This constructor is used by the Lombok-generated builder, and therefore both this constructor and
     * the builder perform validation on the arguments.
     */
    @Builder
    public VaultConfiguration(String ansibleVaultPath, String vaultPasswordFilePath, String tempDirectory) {
        this.ansibleVaultPath = requireNotBlank(ansibleVaultPath);
        this.vaultPasswordFilePath = requireNotBlank(vaultPasswordFilePath);
        this.tempDirectory = isBlank(tempDirectory) ? getJavaTempDir() : tempDirectory;
    }

    private String getJavaTempDir() {
        return System.getProperty("java.io.tmpdir");
    }

    /**
     * Makes a copy of this instance.
     *
     * @return a new instance containing the same values as this instance
     */
    public VaultConfiguration copyOf() {
        return VaultConfiguration.builder()
                .ansibleVaultPath(ansibleVaultPath)
                .vaultPasswordFilePath(vaultPasswordFilePath)
                .tempDirectory(tempDirectory)
                .build();
    }
}