com.github.mjeanroy.junit.servers.tomcat.EmbeddedTomcatFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of junit-servers-tomcat Show documentation
Add Tomcat Embedded Server to your junit tests case.
The newest version!
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2014-2022 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.github.mjeanroy.junit.servers.tomcat;

import com.github.mjeanroy.junit.servers.jetty.EmbeddedJettyConfiguration;
import com.github.mjeanroy.junit.servers.jetty.IllegalJettyConfigurationException;
import com.github.mjeanroy.junit.servers.loggers.Logger;
import com.github.mjeanroy.junit.servers.loggers.LoggerFactory;
import com.github.mjeanroy.junit.servers.servers.AbstractConfiguration;

/**
 * Static factories for {@link EmbeddedTomcat} that can be used in JUnit 4 Runner implementation
 * or JUnit Jupiter Extension.
 *
 * @deprecated Use {@code junit-servers-tomcat-8} instead.
 */
@Deprecated
public final class EmbeddedTomcatFactory extends AbstractEmbeddedTomcatFactory {

	private static final Logger log = LoggerFactory.getLogger(AbstractEmbeddedTomcatFactory.class);
	private static final EmbeddedTomcatFactory INSTANCE = new EmbeddedTomcatFactory();

	/**
	 * Instantiate embedded tomcat from given test class.
	 *
	 * @param testClass The test class.
	 * @return Created embedded tomcat instance.
	 */
	public static EmbeddedTomcat createFrom(Class testClass) {
		log.warn("{} is deprecated and will be removed in the next major release, use junit-servers-tomcat-8 instead, see https://mjeanroy.dev/junit-servers", EmbeddedTomcatFactory.class);
		return INSTANCE.instantiateFrom(testClass, null);
	}

	/**
	 * Instantiate embedded tomcat from given test class, with given provided configuration (may be {@code null}).
	 *
	 * @param testClass The test class.
	 * @param configuration The configuration to use, may be {@code null}.
	 * @return Created embedded tomcat instance.
	 */
	public static EmbeddedTomcat createFrom(Class testClass, AbstractConfiguration configuration) {
		log.warn("{} is deprecated and will be removed in the next major release, use junit-servers-tomcat-8 instead, see https://mjeanroy.dev/junit-servers", EmbeddedTomcatFactory.class);

		if (configuration == null) {
			return createFrom(testClass);
		}

		if (!(configuration instanceof EmbeddedTomcatConfiguration)) {
			throw new IllegalJettyConfigurationException(EmbeddedJettyConfiguration.class);
		}

		return INSTANCE.instantiateFrom(testClass, (EmbeddedTomcatConfiguration) configuration);
	}

	// Ensure non instantiation.
	private EmbeddedTomcatFactory() {
	}

	@Override
	protected EmbeddedTomcat instantiateFrom() {
		return new EmbeddedTomcat();
	}

	@Override
	protected EmbeddedTomcat instantiateFrom(EmbeddedTomcatConfiguration config) {
		return new EmbeddedTomcat(config);
	}
}