Package org.apache.juneau.microservice.tomcat

Class TomcatMicroservice

java.lang.Object

org.apache.juneau.microservice.tomcat.TomcatMicroservice

public final class TomcatMicroservice
extends Object

Zero-config convenience launcher for an embedded-Tomcat-backed Juneau microservice.

Wraps the Microservice + TomcatConfiguration bootstrap in a single static call so a consumer can stand up a Tomcat microservice with one Maven dependency and one line of code:

// Boot Tomcat + Juneau on the default port (8000) with the interactive console enabled. public static void main(String[] args) throws Exception { TomcatMicroservice.run(args, new RootResources()); }

Bundled defaults (all overridable):

• Port 8000 (surfaced as Tomcat/port in a consumer-supplied juneau.cfg).
• Interactive console enabled (use run(String[], Servlet, boolean) with startConsole=false to suppress).
• An auto-created, auto-deleted temp Catalina base directory — a consumer-supplied @Bean TomcatSettings with TomcatSettings.Builder.baseDir(String) wins via the existing TomcatServerComponent resolution chain.

The supplied root servlet is registered as a @Bean Servlet in an external bean store and auto-mounted by TomcatServerComponent at the path declared by its @Rest annotation. Consumers who want full control over the bean store / configuration classes / listener wiring should call Microservice.create() directly — this facade is a thin convenience over that builder.

Since:

10.0.0

Method Summary

Modifier and Type	Method	Description
static Microservice	run(String[] args, jakarta.servlet.Servlet rootServlet)	Boots a Tomcat microservice with the supplied root servlet and the bundled defaults, with the interactive console enabled.
static Microservice	run(String[] args, jakarta.servlet.Servlet rootServlet, boolean startConsole)	Boots a Tomcat microservice with the supplied root servlet and the bundled defaults.
static Microservice	run(String[] args, WritableBeanStore beanStore, boolean startConsole, Class<?>... configurations)	Power-user form: boots a Tomcat microservice with a caller-supplied bean store and configuration class list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

run

public static Microservice run(String[] args,
 jakarta.servlet.Servlet rootServlet)
                        throws Exception

Boots a Tomcat microservice with the supplied root servlet and the bundled defaults, with the interactive console enabled.

Equivalent to calling run(args, rootServlet, true).

Parameters:

args - The main(String[]) arguments. Forwarded to Microservice.Builder#args(String...).

rootServlet - The root REST servlet (typically annotated with @Rest).

Returns:

The started Microservice instance. Callers typically chain Microservice.join().

Throws:

Exception - Error occurred during bootstrap.

run

public static Microservice run(String[] args,
 jakarta.servlet.Servlet rootServlet,
 boolean startConsole)
                        throws Exception

Boots a Tomcat microservice with the supplied root servlet and the bundled defaults.

Constructs the Microservice, registers the supplied servlet as a @Bean Servlet so TomcatServerComponent auto-mounts it, applies TomcatConfiguration so embedded Tomcat itself is wired, and starts the lifecycle. The returned microservice has not yet been joined; callers wanting the standard "start and block forever" loop should chain .join().

Parameters:

args - The main(String[]) arguments. Forwarded to Microservice.Builder#args(String...).

rootServlet - The root REST servlet (typically annotated with @Rest).

startConsole - If true, also starts the interactive console thread via Microservice.startConsole().

Returns:

The started Microservice instance.

Throws:

Exception - Error occurred during bootstrap.

run

public static Microservice run(String[] args,
 WritableBeanStore beanStore,
 boolean startConsole,
 Class<?>... configurations)
                        throws Exception

Power-user form: boots a Tomcat microservice with a caller-supplied bean store and configuration class list.

Equivalent to writing the Microservice builder chain by hand, but with the boilerplate collapsed. Use this when the simpler run(String[], Servlet) overloads are too restrictive — e.g. multiple @Bean Servlet contributions, custom MicroserviceListeners, or a parent bean store.

Parameters:

args - The main(String[]) arguments. Forwarded to Microservice.Builder#args(String...).

beanStore - The bean store to use for dependency injection. Pre-populated bean entries (@Bean Servlet, MicroserviceListener, etc.) are picked up by TomcatConfiguration and the microservice runtime.

startConsole - If true, also starts the interactive console thread.

configurations - The @Configuration-annotated classes to register. Always includes TomcatConfiguration; pass an empty list to use only that.

Returns:

The started Microservice instance.

Throws:

Exception - Error occurred during bootstrap.