com.softicar.platform.common.network.ftp.IFtpClientConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of platform-common Show documentation

The SoftiCAR Platform is a lightweight, Java-based library to create interactive business web applications.

There is a newer version: 50.0.0

package com.softicar.platform.common.network.ftp;

import java.time.Duration;
import java.util.Optional;
import org.apache.commons.net.ftp.FTPClient;

public interface IFtpClientConfig {

	String getHostname();

	String getUsername();

	String getPassword();

	boolean isPassiveMode();

	// ---------------- timeouts ---------------- //

	/**
	 * If present, the value is applied to
	 * {@link FTPClient#setDefaultTimeout(int)}
	 */
	default Optional getDefaultTimeout() {

		return Optional.empty();
	}

	/**
	 * If present, the value is applied to {@link FTPClient#setSoTimeout(int)}
	 */
	default Optional getSoTimeout() {

		return Optional.empty();
	}

	/**
	 * If present, the value is applied to
	 * {@link FTPClient#setConnectTimeout(int)}
	 */
	default Optional getConnectTimeout() {

		return Optional.empty();
	}

	/**
	 * If present, the value is applied to
	 * {@link FTPClient#setDataTimeout(Duration)}
	 */
	default Optional getDataTimeout() {

		return Optional.empty();
	}

	/**
	 * If present, the value is applied to
	 * {@link FTPClient#setControlKeepAliveTimeout(Duration)}
	 */
	default Optional getControlKeepAliveTimeout() {

		return Optional.empty();
	}

	/**
	 * If present, the value is applied to
	 * {@link FTPClient#setControlKeepAliveReplyTimeout(Duration)}
	 */
	default Optional getControlKeepAliveReplyTimeout() {

		return Optional.empty();
	}
}