Package org.apache.juneau.microservice.tomcat

Class TomcatConfiguration

java.lang.Object

org.apache.juneau.microservice.tomcat.TomcatConfiguration

@Configuration
public class TomcatConfiguration
extends Object

@Configuration class that wires embedded Tomcat into a Microservice bootstrap.

Add this class to configurations(...) to enable a Tomcat-backed microservice:

Microservice .create() .args(args) .configurations(TomcatConfiguration.class, MyAppConfig.class) .build() .start() .startConsole() .join();

Contributes the following beans (each gated on @ConditionalOnMissingBean so user-supplied beans of the same type win):

• TomcatServerFactory — defaults to BasicTomcatServerFactory, used to build the Tomcat instance programmatically.
• TomcatSettings — empty defaults; user-supplied @Bean TomcatSettings can override ports and the Catalina base directory.
• TomcatServerComponent (always contributed, also registered under MicroserviceListener) — drives the Tomcat server lifecycle via the microservice's start() / stop() fan-out.

@Bean Servlet methods in user-supplied @Configuration classes are auto-mounted at Rest.path() during start-up. See TomcatServerComponent for full details.

See Also:

• juneau-microservice-tomcat

Since:

10.0.0

Constructor Summary

Constructors

Constructor	Description
TomcatConfiguration()	Constructor.

Method Summary

Modifier and Type	Method	Description
TomcatServerComponent	tomcatServerComponent()	Contributes the TomcatServerComponent bean under its own type for direct lookup by external callers.
TomcatServerFactory	tomcatServerFactory()	Contributes the default Tomcat server factory used to build the Tomcat instance.
MicroserviceListener	tomcatServerListener()	Contributes the same TomcatServerComponent instance under MicroserviceListener (named tomcatServerListener) so it participates in the Microservice.start() / Microservice.stop() fan-out without clobbering any user-supplied unnamed MicroserviceListener.
TomcatSettings	tomcatSettings()	Contributes an empty default TomcatSettings so TomcatServerComponent always finds one in the store.

Methods inherited from class java.lang.Object

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

Constructor Details

TomcatConfiguration

public TomcatConfiguration()

Constructor.

Method Details

tomcatServerFactory

@ConditionalOnMissingBean(TomcatServerFactory.class)
public TomcatServerFactory tomcatServerFactory()

Contributes the default Tomcat server factory used to build the Tomcat instance.

Returns:

The default factory.

tomcatSettings

@ConditionalOnMissingBean(TomcatSettings.class)
public TomcatSettings tomcatSettings()

Contributes an empty default TomcatSettings so TomcatServerComponent always finds one in the store. Users who need programmatic overrides supply their own @Bean TomcatSettings.

Returns:

The default empty settings.

tomcatServerComponent

public TomcatServerComponent tomcatServerComponent()

Contributes the TomcatServerComponent bean under its own type for direct lookup by external callers.

Returns:

The component instance.

tomcatServerListener

public MicroserviceListener tomcatServerListener()

Contributes the same TomcatServerComponent instance under MicroserviceListener (named tomcatServerListener) so it participates in the Microservice.start() / Microservice.stop() fan-out without clobbering any user-supplied unnamed MicroserviceListener.

Returns:

The component instance.