io.helidon.integrations.vault.secrets.kv2.GetKv2 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of helidon-integrations-vault-secrets-kv2 Show documentation
Key/Value secrets engine version 2 support for Vault.
There is a newer version: 4.1.4
Show newest version
/*
 * Copyright (c) 2021 Oracle and/or its affiliates.
 *
 * 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
 *
 *     http://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 io.helidon.integrations.vault.secrets.kv2;

import java.util.Map;
import java.util.Optional;

import io.helidon.integrations.common.rest.ApiJsonParser;
import io.helidon.integrations.vault.VaultApiException;
import io.helidon.integrations.vault.VaultRequest;
import io.helidon.integrations.vault.VaultUtil;

import jakarta.json.JsonObject;

/**
 * Get KV2 secret request and response.
 */
public final class GetKv2 {
    private GetKv2() {
    }

    /**
     * Request object. Can be configured with additional headers, query parameters etc.
     */
    public static final class Request extends VaultRequest {
        private String path;

        private Request() {
        }

        /**
         * Fluent API builder for configuring a request.
         * The request builder is passed as is, without a build method.
         * The equivalent of a build method is {@link #toJson(jakarta.json.JsonBuilderFactory)}
         * used by the {@link io.helidon.integrations.common.rest.RestApi}.
         *
         * @return new request builder
         */
        public static Request builder() {
            return new Request();
        }

        /**
         * Create a request for path.
         *
         * @param path path of the secret to get
         * @return new request
         */
        public static Request create(String path) {
            return builder().path(path);
        }

        /**
         * Path of the secret to get.
         *
         * @param path secret's path
         * @return updated request
         */
        public Request path(String path) {
            this.path = path;
            return this;
        }

        /**
         * Version of the secret to get.
         *
         * @param version secret's version
         * @return updated request
         */
        public Request version(int version) {
            return addQueryParam("version", String.valueOf(version));
        }

        String path() {
            if (path == null) {
                throw new VaultApiException("GetKv2.Request path must be configured");
            }
            return path;
        }
    }

    /**
     * Response object parsed from JSON returned by the {@link io.helidon.integrations.common.rest.RestApi}.
     */
    public static final class Response extends ApiJsonParser implements Kv2Secret {
        private final String path;
        private final Map values;
        private final Kv2Metadata metadata;

        private Response(String path, JsonObject json) {
            this.path = path;
            JsonObject mainData = json.getJsonObject("data");
            this.metadata = Kv2Metadata.create(mainData.getJsonObject("metadata"));
            this.values = VaultUtil.toMap(mainData, "data");
        }

        static Response create(String path, JsonObject json) {
            return new Response(path, json);
        }

        @Override
        public Kv2Metadata metadata() {
            return metadata;
        }

        @Override
        public String path() {
            return path;
        }

        @Override
        public Optional value(String key) {
            return Optional.ofNullable(values.get(key));
        }

        @Override
        public Map values() {
            return values;
        }
    }
}