Package net.officefloor.servlet.tomcat

Class TomcatServletManager

java.lang.Object

net.officefloor.servlet.tomcat.TomcatServletManager

All Implemented Interfaces:

ServletManager, ServletServicer

public class TomcatServletManager
extends Object
implements ServletManager, ServletServicer

Tomcat ServletServicer.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TomcatServletManager.FilterChainHttpServlet	HttpServlet to handle FilterChain.
static interface	TomcatServletManager.Operation<R,T extends Throwable>	Operation to run.
static class	TomcatServletManager.SetupApplicationListener	ServletContextListener for application setup.

Constructor Summary

Constructors

Constructor	Description
TomcatServletManager(String contextPath, InjectionRegistry injectionRegistry, OfficeExtensionContext sourceContext, String webAppPath)	Instantiate.

Method Summary

Modifier and Type	Method	Description
FilterServicer	addFilter(String name, Class<? extends jakarta.servlet.Filter> filterClass, Consumer<org.apache.tomcat.util.descriptor.web.FilterDef> decorator)	Adds a Filter.
ServletServicer	addServlet(String name, jakarta.servlet.Servlet servlet, boolean isInjectDependencies, Consumer<org.apache.catalina.Wrapper> decorator)	Adds a Servlet instance.
ServletServicer	addServlet(String name, Class<? extends jakarta.servlet.Servlet> servletClass, Consumer<org.apache.catalina.Wrapper> decorator)	Adds a Servlet.
void	chainInServletManager()	Chains in this ServletManager to service HTTP requests.
AvailableType[]	getAvailableTypes()	Obtains the AvailableType instances from OfficeFloor.
org.apache.catalina.Context	getContext()	Obtains the Context.
<T> T	getDependency(String qualifier, Class<? extends T> type)	Obtains a dependency.
OfficeExtensionContext	getSourceContext()	Obtains the OfficeExtensionContext.
boolean	isChainServletManager()	Indicates if chain in the ServletManager.
static <R, T extends Throwable> R	runInMavenWarProject(TomcatServletManager.Operation<R,T> operation)	Runs the TomcatServletManager.Operation assuming within Maven war project.
void	service(ServerHttpConnection connection, Executor executor, AsynchronousFlow asynchronousFlow, AsynchronousFlowCompletion asynchronousFlowCompletion, Map<String,? extends Object> attributes)	Services the ServerHttpConnection.
void	setSupplierSourceContext(SupplierSourceContext supplierSourceContext)	Specifies the SupplierSourceContext.
void	start(AvailableType[] availableTypes)	Starts the Servlet container.
void	stop()	Stops the Servlet container.

Methods inherited from class java.lang.Object

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

Constructor Details

TomcatServletManager

public TomcatServletManager(String contextPath,
 InjectionRegistry injectionRegistry,
 OfficeExtensionContext sourceContext,
 String webAppPath)
                     throws IOException

Instantiate.

Parameters:

contextPath - Context path.

injectionRegistry - InjectionRegistry.

sourceContext - OfficeExtensionContext.

webAppPath - Path to web application (WAR). May be null.

Throws:

IOException - If fails to setup container.

Method Details

runInMavenWarProject

public static <R,
T extends Throwable> R runInMavenWarProject(TomcatServletManager.Operation<R,T> operation)
                                                      throws T

Runs the TomcatServletManager.Operation assuming within Maven war project.

Type Parameters:

R - Return type.

T - Possible exception type.

Parameters:

operation - TomcatServletManager.Operation.

Returns:

Result.

Throws:

T - Possible failure.

setSupplierSourceContext

public void setSupplierSourceContext(SupplierSourceContext supplierSourceContext)

Specifies the SupplierSourceContext.

Parameters:

supplierSourceContext - SupplierSourceContext.

isChainServletManager

public boolean isChainServletManager()

Indicates if chain in the ServletManager.

Returns:

true to chain in the ServletManager.

start

public void start(AvailableType[] availableTypes)
           throws Exception

Starts the Servlet container.

Parameters:

availableTypes - AvailableType instances.

Throws:

Exception - If fails to start.

stop

public void stop()
          throws Exception

Stops the Servlet container.

Throws:

Exception - If fails to stop.

service

public void service(ServerHttpConnection connection,
 Executor executor,
 AsynchronousFlow asynchronousFlow,
 AsynchronousFlowCompletion asynchronousFlowCompletion,
 Map<String,? extends Object> attributes)
             throws Exception

Description copied from interface: ServletServicer

Services the ServerHttpConnection.

Specified by:

service in interface ServletServicer

Parameters:

connection - ServerHttpConnection.

executor - Executor.

asynchronousFlow - AsynchronousFlow to allow for AsyncContext.

asynchronousFlowCompletion - AsynchronousFlowCompletion for handling completion of servicing.

attributes - Optional attributes to load to the HttpServletRequest. May be null.

Throws:

Exception - If fails to service.

getContext

public org.apache.catalina.Context getContext()

Description copied from interface: ServletManager

Obtains the Context.

Specified by:

getContext in interface ServletManager

Returns:

Context.

addServlet

public ServletServicer addServlet(String name,
 Class<? extends jakarta.servlet.Servlet> servletClass,
 Consumer<org.apache.catalina.Wrapper> decorator)

Description copied from interface: ServletManager

Adds a Servlet.

Specified by:

addServlet in interface ServletManager

Parameters:

name - Name of Servlet.

servletClass - Servlet Class.

decorator - Decorates the Servlet. May be null.

Returns:

ServletServicer.

addServlet

public ServletServicer addServlet(String name,
 jakarta.servlet.Servlet servlet,
 boolean isInjectDependencies,
 Consumer<org.apache.catalina.Wrapper> decorator)

Description copied from interface: ServletManager

Adds a Servlet instance.

Specified by:

addServlet in interface ServletManager

Parameters:

name - Name of Servlet.

servlet - Servlet.

isInjectDependencies - Flags to inject dependencies into the Servlet instance.

decorator - Decorates the Servlet. May be null.

Returns:

ServletServicer.

addFilter

public FilterServicer addFilter(String name,
 Class<? extends jakarta.servlet.Filter> filterClass,
 Consumer<org.apache.tomcat.util.descriptor.web.FilterDef> decorator)

Description copied from interface: ServletManager

Adds a Filter.

Specified by:

addFilter in interface ServletManager

Parameters:

name - Name of Filter.

filterClass - Filter Class.

decorator - Decorates the Filter. May be null.

Returns:

FilterServicer.

getDependency

public <T> T getDependency(String qualifier,
 Class<? extends T> type)

Description copied from interface: ServletManager

Obtains a dependency.

The dependency is via a SupplierThreadLocal that is always available in servicing a Servlet / Filter.

Specified by:

getDependency in interface ServletManager

Type Parameters:

T - Type of dependency.

Parameters:

qualifier - Qualifier. May be null.

type - Type.

Returns:

Dependency.

getAvailableTypes

public AvailableType[] getAvailableTypes()

Description copied from interface: ServletManager

Obtains the AvailableType instances from OfficeFloor.

This should only be invoked during Servlet container startup.

Specified by:

getAvailableTypes in interface ServletManager

Returns:

AvailableType instances from OfficeFloor.

chainInServletManager

public void chainInServletManager()

Description copied from interface: ServletManager

Chains in this ServletManager to service HTTP requests. This allows the backing Servlet container to route requests to the appropriate Filter / Servlet to service the HTTP request.

Specified by:

chainInServletManager in interface ServletManager

getSourceContext

public OfficeExtensionContext getSourceContext()

Description copied from interface: ServletManager

Obtains the OfficeExtensionContext.

Specified by:

getSourceContext in interface ServletManager

Returns:

OfficeExtensionContext.