au.com.agic.apptesting.utils.LocalProxyUtils Maven / Gradle / Ivy

Go to download
package au.com.agic.apptesting.utils;

import java.io.File;
import java.util.List;
import java.util.Optional;

import javax.validation.constraints.NotNull;

/**
 * Our tests will often need to startup local proxy servers in order to perform tests. This
 * interface provides services for working with these proxies.
 */
public interface LocalProxyUtils {
	/**
	 * Attempts to match the value assigned to the startInternalProxy system property with a
	 * supported internal proxy, and starts it if a match was found.
	 * @param tempFolders A collection that will be populate with any temporary folders to be cleaned up once the
	 *                    test has completed
	 * @param upstreamProxy The details of the upstream proxy
	 * @return Some kind of interface that can be used to access the proxy. This might be a port, or a client
	 * api object.
	 */
	Optional> initProxy(
		@NotNull final List tempFolders,
		@NotNull final Optional upstreamProxy);
}