Package net.officefloor.servlet.supply

Class ServletSupplierSource

java.lang.Object

net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

net.officefloor.servlet.supply.ServletSupplierSource

All Implemented Interfaces:

SupplierSource

public class ServletSupplierSource
extends AbstractSupplierSource

SupplierSource to provide Servlet functionality.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

AbstractSupplierSource.SpecificationContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_CHAIN_SERVLETS	Property name to chain the ServletManager in to service HttpRequest instances via Filter/Servlet mappings.

Constructor Summary

Constructors

Constructor	Description
ServletSupplierSource(TomcatServletManager servletContainer, InjectionRegistry injectionRegistry)	Instantiate.

Method Summary

Modifier and Type	Method	Description
static ServletServicer	forceStartServletContainer(AvailableType[] availableTypes)	Force starts the Servlet container.
static ServletManager	getServletManager()	Obtains the ServletManager.
protected void	loadSpecification(AbstractSupplierSource.SpecificationContext context)	Loads the SupplierSourceSpecification.
static void	registerForInjection(String className)	Registers the Class for injection.
static void	sendError(Throwable failure, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Sends an error.
void	supply(SupplierSourceContext context)	Supplies the necessary ManagedObjectSource instances.
void	terminate()	Terminates the supply contract.

Methods inherited from class net.officefloor.compile.spi.supplier.source.impl.AbstractSupplierSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_CHAIN_SERVLETS

public static final String PROPERTY_CHAIN_SERVLETS

Property name to chain the ServletManager in to service HttpRequest instances via Filter/Servlet mappings.

See Also:

• Constant Field Values

Constructor Details

ServletSupplierSource

public ServletSupplierSource(TomcatServletManager servletContainer,
 InjectionRegistry injectionRegistry)

Instantiate.

Parameters:

servletContainer - TomcatServletManager.

injectionRegistry - InjectionRegistry.

Method Details

getServletManager

public static ServletManager getServletManager()

Obtains the ServletManager.

Returns:

ServletManager.

sendError

public static void sendError(Throwable failure,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                      throws IOException

Sends an error.

The Throwable will (in most cases) be reported back to OfficeFloor for appropriate Exception response. If not possible, an appropriate Exception message is also provided.

Parameters:

failure - Failure.

request - HttpServletRequest.

response - HttpServletResponse.

Throws:

IOException - If fails to send error.

registerForInjection

public static void registerForInjection(String className)
                                 throws Exception

Registers the Class for injection.

Parameters:

className - Class name.

Throws:

Exception - If fails to register for injection.

forceStartServletContainer

public static ServletServicer forceStartServletContainer(AvailableType[] availableTypes)
                                                  throws Exception

Force starts the Servlet container.

Parameters:

availableTypes - AvailableType instances.

Returns:

ServletServicer to the Servlet container.

Throws:

Exception - If fails to start Servlet container.

loadSpecification

protected void loadSpecification(AbstractSupplierSource.SpecificationContext context)

Description copied from class: AbstractSupplierSource

Loads the SupplierSourceSpecification.

Specified by:

loadSpecification in class AbstractSupplierSource

Parameters:

context - AbstractSupplierSource.SpecificationContext.

supply

public void supply(SupplierSourceContext context)
            throws Exception

Description copied from interface: SupplierSource

Supplies the necessary ManagedObjectSource instances.

Parameters:

context - SupplierSourceContext.

Throws:

Exception - If fails to provide supply of ManagedObjectSource instances.

terminate

public void terminate()

Description copied from interface: SupplierSource

Terminates the supply contract.

This should release all resources required by the supplier.