fish.payara.microprofile.config.extensions.toml.admin.SetTOMLConfigurationCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-embedded-web Show documentation
Embedded-Web Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha3
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2024 Payara Foundation and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://github.com/payara/Payara/blob/main/LICENSE.txt
 * See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at glassfish/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * The Payara Foundation designates this particular file as subject to the "Classpath"
 * exception as provided by the Payara Foundation in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package fish.payara.microprofile.config.extensions.toml.admin;

import fish.payara.microprofile.config.extensions.toml.TOMLConfigSourceConfiguration;
import fish.payara.nucleus.microprofile.config.source.extension.BaseSetConfigSourceConfigurationCommand;
import fish.payara.nucleus.microprofile.config.spi.MicroprofileConfigConfiguration;
import org.glassfish.api.ActionReport;
import org.glassfish.api.Param;
import org.glassfish.api.admin.CommandLock;
import org.glassfish.api.admin.ExecuteOn;
import org.glassfish.api.admin.RestEndpoint;
import org.glassfish.api.admin.RestEndpoints;
import org.glassfish.api.admin.RuntimeType;
import org.glassfish.config.support.CommandTarget;
import org.glassfish.config.support.TargetType;
import org.glassfish.hk2.api.PerLookup;
import org.jvnet.hk2.annotations.Service;

import java.beans.PropertyVetoException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

/**
 * asAdmin command to the set the configuration for the TOML Config Source
 *
 * @since 6.2024.11
 * @author Kalin Chan (Payara Foundation)
 */
@Service(name = "set-toml-config-source-configuration")
@PerLookup
@CommandLock(CommandLock.LockType.NONE)
@ExecuteOn({RuntimeType.DAS, RuntimeType.INSTANCE})
@TargetType(value = {CommandTarget.DAS, CommandTarget.STANDALONE_INSTANCE, CommandTarget.CLUSTER, CommandTarget.CLUSTERED_INSTANCE, CommandTarget.CONFIG, CommandTarget.DEPLOYMENT_GROUP})
@RestEndpoints({
    @RestEndpoint(configBean = MicroprofileConfigConfiguration.class,
            opType = RestEndpoint.OpType.POST,
            path = "set-toml-config-source-configuration",
            description = "Configures TOML Config Source")
})
public class SetTOMLConfigurationCommand extends BaseSetConfigSourceConfigurationCommand {
    
    @Param
    private String path;

    @Param
    private int depth;


    @Override
    protected void applyValues(ActionReport report, TOMLConfigSourceConfiguration configuration) throws PropertyVetoException {
        // do validation
        Path tomlPath = Paths.get(path);
        if (!Files.exists(tomlPath) || !Files.isReadable(tomlPath)) {
            // try relative to the server root
            report.appendMessage("Could not find readable file at " + tomlPath + "\n");
            if (tomlPath.isAbsolute()) {
                report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                return;
            }
            Path instanceRoot = server.getInstanceRoot().toPath();
            Path relative = Paths.get(instanceRoot.toString(), path);
            if (!Files.exists(relative) || !Files.isReadable(relative)) {
                report.appendMessage("Could not find readable file at " + relative + "\n");
                report.setActionExitCode(ActionReport.ExitCode.FAILURE);
                return;
            }
            tomlPath = relative;
        }
        report.appendMessage("Using readable file at " + tomlPath + "\n");

        super.applyValues(report, configuration);
        if (depth > 0) {
            configuration.setDepth(String.valueOf(depth));
        }

        if (path != null) {
            configuration.setPath(String.valueOf(tomlPath));
        }
    }
    
}