Debug.java

package io.github.jopenlibs.vault.api;

import io.github.jopenlibs.vault.VaultConfig;
import io.github.jopenlibs.vault.VaultException;
import io.github.jopenlibs.vault.response.HealthResponse;
import io.github.jopenlibs.vault.rest.Rest;
import io.github.jopenlibs.vault.rest.RestResponse;
import java.util.HashSet;
import java.util.Set;


/**
 * <p>The implementing class for operations on REST endpoints, under the "Debug" section of the
 * Vault HTTP API docs (https://www.vaultproject.io/docs/http/index.html).</p>
 *
 * <p>This class is not intended to be constructed directly.  Rather, it is meant to used by way of
 * <code>Vault</code> in a DSL-style builder pattern.  See the Javadoc comments of each
 * <code>public</code>
 * method for usage examples.</p>
 */
public class Debug extends OperationsBase {

    private String nameSpace;

    public Debug(final VaultConfig config) {
        super(config);

        if (this.config.getNameSpace() != null && !this.config.getNameSpace().isEmpty()) {
            this.nameSpace = this.config.getNameSpace();
        }
    }

    public Debug withNameSpace(final String nameSpace) {
        this.nameSpace = nameSpace;
        return this;
    }


    /**
     * <p>Returns the health status of Vault. This matches the semantics of a Consul HTTP
     * health check and provides a simple way to monitor the health of a Vault instance.</p>
     *
     * @return The response information returned from Vault
     * @throws VaultException If any errors occurs with the REST request (e.g. non-200 status code,
     * invalid JSON payload, etc), and the maximum number of retries is exceeded.
     * @see <a
     * href="https://www.vaultproject.io/docs/http/sys-health.html">https://www.vaultproject.io/docs/http/sys-health.html</a>
     *
     * <blockquote>
     * <pre>{@code
     * final VaultConfig config = new VaultConfig.address(...).token(...).build();
     * final Vault vault = Vault.create(config);
     *
     * final HealthResponse response = vault.sys().debug().health();
     *
     * final Boolean sealed = response.getSealed();  // Warning: CAN be null!
     * }</pre>
     * </blockquote>
     */
    public HealthResponse health() throws VaultException {
        return health(null, null, null, null, null, null, null, null);
    }

    /**
     * <p>An overloaded version of {@link Debug#health()} that allows for passing one or more
     * optional parameters.</p>
     *
     * <p>WARNING:  In testing, we've found that changing the default HTTP status codes can result
     * in the operation succeeding, but returning an empty JSON payload in the response.  For
     * example, this seems to happen when you set <code>activeCode</code> to 204, but not for 212
     * (the regular default is 200).  When this happens, the
     * <code>HealthResponse</code> return object will have <code>null</code> values in most of its
     * fields, and you will need to check <code>HealthReponse.getRestResponse().getStatus()</code>
     * to determine the result of the operation.</p>
     *
     * @param standbyOk (optional) Indicates that being a standby should still return the active
     * status code instead of the standby code
     * @param perfstandbyOk (optional) Indicates that being a performance standby should still
     * return the active status code instead of the performance standby code.
     * @param activeCode (optional) Indicates the status code that should be returned for an active
     * node instead of the default of 200
     * @param standbyCode (optional) Indicates the status code that should be returned for a standby
     * node instead of the default of 429
     * @param drsecondaryCode (optional) Indicates the status code that should be returned for a DR
     * secondary node instead of the default of 472
     * @param performanceStandbyCode (optional) Indicates the status code that should be returned
     * for a performance standby node instead of the default of 473
     * @param sealedCode (optional) Indicates the status code that should be returned for a sealed
     * node instead of the default of 500
     * @param uninitCode (optional) Indicates the status code that should be returned for a
     * uninitialized node instead of the default of 500
     * @return The response information returned from Vault
     * @throws VaultException If an error occurs or unexpected response received from Vault
     */
    public HealthResponse health(
            final Boolean standbyOk,
            final Boolean perfstandbyOk,
            final Integer activeCode,
            final Integer standbyCode,
            final Integer drsecondaryCode,
            final Integer performanceStandbyCode,
            final Integer sealedCode,
            final Integer uninitCode
    ) throws VaultException {
        final String path = "sys/health";

        return retry(attempt -> {
            // Build an HTTP request for Vault
            final Rest rest = getRest()//NOPMD
                    .url(config.getAddress() + "/v1/" + path)
                    .token(config.getToken())
                    .header("X-Vault-Namespace", this.nameSpace)
                    .header("X-Vault-Request", "true")
                    .connectTimeoutSeconds(config.getOpenTimeout())
                    .readTimeoutSeconds(config.getReadTimeout())
                    .sslVerification(config.getSslConfig().isVerify())
                    .sslContext(config.getSslConfig().getSslContext());
            // Add params if present
            if (standbyOk != null) {
                rest.parameter("standbyok", standbyOk.toString());
            }
            if (perfstandbyOk != null) {
                rest.parameter("perfstandbyok", perfstandbyOk.toString());
            }
            if (activeCode != null) {
                rest.parameter("activecode", activeCode.toString());
            }
            if (standbyCode != null) {
                rest.parameter("standbycode", standbyCode.toString());
            }
            if (drsecondaryCode != null) {
                rest.parameter("drsecondarycode", drsecondaryCode.toString());
            }
            if (performanceStandbyCode != null) {
                rest.parameter("performancestandbycode", performanceStandbyCode.toString());
            }
            if (sealedCode != null) {
                rest.parameter("sealedcode", sealedCode.toString());
            }
            if (uninitCode != null) {
                rest.parameter("uninitcode", uninitCode.toString());
            }
            // Execute request
            final RestResponse restResponse = rest.get();

            // Validate response
            final Set<Integer> validCodes = new HashSet<>();//NOPMD
            validCodes.add(200);
            validCodes.add(429);
            validCodes.add(472);
            validCodes.add(473);
            validCodes.add(500);
            validCodes.add(501);
            validCodes.add(503);
            if (activeCode != null) {
                validCodes.add(activeCode);
            }
            if (standbyCode != null) {
                validCodes.add(standbyCode);
            }
            if (drsecondaryCode != null) {
                validCodes.add(drsecondaryCode);
            }
            if (sealedCode != null) {
                validCodes.add(sealedCode);
            }
            if (performanceStandbyCode != null) {
                validCodes.add(performanceStandbyCode);
            }
            if (uninitCode != null) {
                validCodes.add(uninitCode);
            }

            if (!validCodes.contains(restResponse.getStatus())) {
                throw new VaultException(
                        "Vault responded with HTTP status code: " + restResponse.getStatus(),
                        restResponse.getStatus());
            }

            return new HealthResponse(restResponse, attempt);
        });
    }
}