com.bettercloud.vault.response.VaultResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vault-java-driver Show documentation

Zero-dependency Java client for HashiCorp's Vault

There is a newer version: 5.1.0

package com.bettercloud.vault.response;

import com.bettercloud.vault.rest.RestResponse;

import java.io.Serializable;

/**
 * VaultResponse is a common base class for the response objects returned by
 * all API methods.  It contains the bare minimum of information common to all Vault
 * responses (e.g. the raw HTTP response, the number of retry attempts if any).  API methods
 * which return additional information will use more specialized subclasses inheriting
 * from VaultResponse.
 *
 * NOTE: It turns out that not all API methods will populate leaseId,
 * renewable, and leaseDuration.  In fact, many response types won't.
 * So the next major release will implement those fields directly in the subclasses where they're
 * used.
 */
public class VaultResponse implements Serializable {

    private RestResponse restResponse;
    private int retries;

    /**
     * @param restResponse The raw HTTP response from Vault.
     * @param retries The number of retry attempts that occurred during the API call (can be zero).
     */
    public VaultResponse(final RestResponse restResponse, final int retries) {
        this.restResponse = restResponse;
        this.retries = retries;
    }

    public RestResponse getRestResponse() {
        return restResponse;
    }

    public int getRetries() {
        return retries;
    }
}