Class Tomcat

java/org/apache/catalina/startup/Tomcat.java:135–1326

Minimal tomcat starter for embedding/unit tests. Tomcat supports multiple styles of configuration and startup - the most common and stable is server.xml-based, implemented in org.apache.catalina.startup.Bootstrap. This class is for use in apps that embed tomcat. Requirements: al

 *          "https://gitbox.apache.org/repos/asf?p=tomcat.git;a=blob;f=test/org/apache/catalina/startup/TestTomcat.java">TestTomcat</a>
 */
public class Tomcat {

    private static final StringManager sm = StringManager.getManager(Tomcat.class);

    // Some logging implementations use weak references for loggers so there is
    // the possibility that logging configuration could be lost if GC runs just
    // after Loggers are configured but before they are used. The purpose of
    // this Map is to retain strong references to explicitly configured loggers
    // so that configuration is not lost.
    private final Map<String,Logger> pinnedLoggers = new HashMap<>();

    /**
     * The embedded Server instance.
     */
    protected Server server;

    /**
     * The HTTP connector port.
     */
    protected int port = 8080;

    /**
     * The default hostname.
     */
    protected String hostname = "localhost";

    /**
     * The base directory for the embedded server.
     */
    protected String basedir;

    private final Map<String,String> userPass = new HashMap<>();
    private final Map<String,List<String>> userRoles = new HashMap<>();
    private final Map<String,Principal> userPrincipals = new HashMap<>();

    private boolean addDefaultWebXmlToWebapp = true;

    /**
     * Constructs a new embedded Tomcat instance with default settings.
     */
    public Tomcat() {
        ExceptionUtils.preload();
    }

    /**
     * Tomcat requires that the base directory is set because the defaults for a number of other locations, such as the
     * work directory, are derived from the base directory. This should be the first method called.
     * <p>
     * If this method is not called then Tomcat will attempt to use these locations in the following order:
     * <ol>
     * <li>if set, the catalina.base system property</li>
     * <li>if set, the catalina.home system property</li>
     * <li>The user.dir system property (the directory where Java was run from) where a directory named tomcat.$PORT
     * will be created. $PORT is the value configured via {@link #setPort(int)} which defaults to 8080 if not set</li>
     * </ol>
     * The user should ensure that the file permissions for the base directory are appropriate.
     * <p>
     * TODO: disable work dir if not needed ( no jsp, etc ).