/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.neo4j.server.startup;

import static java.util.Objects.requireNonNull;

import java.io.PrintStream;
import java.util.Collection;
import java.util.List;
import org.neo4j.annotations.service.Service;
import org.neo4j.graphdb.config.Configuration;
import org.neo4j.service.Services;

/**
 * BootloaderExtension can provide additional JVM options and arguments for Neo4j instance.
 * If jvmOptions include memory options -Xms and -Xmx they will override values from config, but not override value from HEAP_SIZE env variable.
 */
@Service
public interface BootloaderExtension {

    record BootloaderArguments(List<String> jvmOptions, List<String> additionalArguments) {
        public BootloaderArguments {
            requireNonNull(jvmOptions, "jvmOptions must not be null");
            requireNonNull(additionalArguments, "additionalArguments must not be null");
        }
    }

    BootloaderArguments EMPTY_ARGUMENTS = new BootloaderArguments(List.of(), List.of());

    record ExtensionContext(Configuration config, PrintStream out, PrintStream err) {}

    BootloaderArguments getBootloaderArguments(ExtensionContext context);

    static Collection<BootloaderExtension> serviceLoadExtensions() {
        return Services.loadAll(BootloaderExtension.class);
    }
}
