001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.juneau.microservice.tomcat;
018
019import java.io.*;
020
021import org.apache.catalina.startup.*;
022
023/**
024 * Interface for creating embedded Tomcat servers.
025 *
026 * <p>
027 * Mirrors {@code org.apache.juneau.marshall.microservice.jetty.JettyServerFactory} but uses the programmatic
028 * {@link Tomcat} façade instead of a {@code jetty.xml} document.
029 *
030 * <h5 class='section'>See Also:</h5><ul>
031 *    <li class='link'><a class="doclink" href="https://juneau.apache.org/docs/topics/JuneauMicroserviceTomcat">juneau-microservice-tomcat</a>
032 * </ul>
033 */
034public interface TomcatServerFactory {
035
036   /**
037    * Create a new initialized embedded Tomcat server.
038    *
039    * <p>
040    * The returned server is configured with the specified Catalina base directory and a root context (mounted
041    * at <c>""</c>) but is not yet started and has no connector port assigned — the {@link TomcatServerComponent}
042    * assigns the port and materializes the connector before calling {@link Tomcat#start()}.
043    *
044    * @param baseDir The writable Catalina base / work directory to use for this server.
045    * @return A newly-created but not-yet-started Tomcat server.
046    * @throws Exception Any exception.
047    */
048   @SuppressWarnings({
049      "java:S112" // throws Exception intentional - callback/lifecycle method
050   })
051   Tomcat create(File baseDir) throws Exception;
052}