org.springframework.vault.support.VaultResponseSupport.java Source code

Introduction

Here is the source code for org.springframework.vault.support.VaultResponseSupport.java

Source

/*
 * Copyright 2016-2019 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.vault.support;

import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

import org.springframework.lang.Nullable;

/**
 * Value object to bind generic Vault HTTP API responses.
 *
 * @param <T> type for {@code data} response.
 * @author Spencer Gibb
 * @author Mark Paluch
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class VaultResponseSupport<T> {

    @Nullable
    private Map<String, Object> auth;

    @Nullable
    private T data;

    @Nullable
    private Map<String, Object> metadata;

    @JsonProperty("wrap_info")
    @Nullable
    private Map<String, String> wrapInfo;

    @JsonProperty("lease_duration")
    private long leaseDuration;

    @JsonProperty("lease_id")
    @Nullable
    private String leaseId;

    @JsonProperty("request_id")
    @Nullable
    private String requestId;

    private boolean renewable;

    @Nullable
    private List<String> warnings;

    /**
     * @return authentication payload.
     */
    @Nullable
    public Map<String, Object> getAuth() {
        return auth;
    }

    /**
     * @return the authentication payload.
     * @throws IllegalStateException if {@code auth} is null.
     */
    public Map<String, Object> getRequiredAuth() {

        if (auth != null) {
            return auth;
        }

        throw new IllegalStateException("Auth field is empty");
    }

    /**
     * @param auth the authentication payload.
     */
    public void setAuth(@Nullable Map<String, Object> auth) {
        this.auth = auth;
    }

    /**
     * @return secret data.
     */
    @Nullable
    public T getData() {
        return data;
    }

    /**
     * @return the required secret data.
     * @throws IllegalStateException if {@code data} is null.
     */
    public T getRequiredData() {

        if (data != null) {
            return data;
        }

        throw new IllegalStateException("Data field is empty");
    }

    /**
     * @param data secret data.
     */
    public void setData(@Nullable T data) {
        this.data = data;
    }

    /**
     * @return request metadata.
     */
    @Nullable
    public Map<String, Object> getMetadata() {
        return metadata;
    }

    /**
     *
     * @param metadata request metadata.
     */
    public void setMetadata(@Nullable Map<String, Object> metadata) {
        this.metadata = metadata;
    }

    /**
     *
     * @return the lease duration.
     */
    public long getLeaseDuration() {
        return leaseDuration;
    }

    /**
     *
     * @param leaseDuration the lease duration.
     */
    public void setLeaseDuration(long leaseDuration) {
        this.leaseDuration = leaseDuration;
    }

    /**
     *
     * @return the lease Id.
     */
    @Nullable
    public String getLeaseId() {
        return leaseId;
    }

    /**
     *
     * @param leaseId the lease Id.
     */
    public void setLeaseId(@Nullable String leaseId) {
        this.leaseId = leaseId;
    }

    /**
     *
     * @return {@literal true} if the lease is renewable.
     */
    public boolean isRenewable() {
        return renewable;
    }

    /**
     *
     * @param renewable {@literal true} if the lease is renewable.
     */
    public void setRenewable(boolean renewable) {
        this.renewable = renewable;
    }

    /**
     *
     * @return response wrapping details.
     */
    @Nullable
    public Map<String, String> getWrapInfo() {
        return wrapInfo;
    }

    /**
     *
     * @param wrapInfo response wrapping details.
     */
    public void setWrapInfo(@Nullable Map<String, String> wrapInfo) {
        this.wrapInfo = wrapInfo;
    }

    /**
     *
     * @return the request Id.
     */
    @Nullable
    public String getRequestId() {
        return requestId;
    }

    /**
     *
     * @param requestId the request Id.
     */
    public void setRequestId(@Nullable String requestId) {
        this.requestId = requestId;
    }

    /**
     *
     * @return the warnings.
     */
    @Nullable
    public List<String> getWarnings() {
        return warnings;
    }

    /**
     *
     * @param warnings the warnings.
     */
    public void setWarnings(@Nullable List<String> warnings) {
        this.warnings = warnings;
    }
}