org.sentrysoftware.metricshub.cli.service.protocol.IProtocolConfigCli Maven / Gradle / Ivy

Go to download
package org.sentrysoftware.metricshub.cli.service.protocol;

/*-
 * ╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲
 * MetricsHub Agent
 * ჻჻჻჻჻჻
 * Copyright 2023 - 2024 Sentry Software
 * ჻჻჻჻჻჻
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License
 * along with this program.  If not, see .
 * ╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱╲╱
 */

import org.sentrysoftware.metricshub.engine.common.exception.InvalidConfigurationException;
import org.sentrysoftware.metricshub.engine.configuration.IConfiguration;

/**
 * Interface for CLI configurations of protocols to convert to core engine configurations.
 */
public interface IProtocolConfigCli {
	/**
	 * Convert the CLI configuration to the core engine configuration
	 *
	 * @param defaultUsername Username to use in case the protocol username is undefined
	 * @param defaultPassword Password to use in case the protocol password is undefined
	 *
	 * @return Instance of {@link IConfiguration}
	 * @throws InvalidConfigurationException if the configuration is invalid.
	 */
	IConfiguration toProtocol(String defaultUsername, char[] defaultPassword) throws InvalidConfigurationException;
}