net.officefloor.plugin.servlet

Class ServletWebAutoWireApplication<S extends OfficeFloorServlet>

java.lang.Object

net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

net.officefloor.autowire.impl.AutoWireOfficeFloorSource

net.officefloor.plugin.web.http.application.WebApplicationAutoWireOfficeFloorSource

net.officefloor.plugin.servlet.ServletWebAutoWireApplication<S>

All Implemented Interfaces:

AutoWireApplication, OfficeFloorSource, WebAutoWireApplication

public class ServletWebAutoWireApplication<S extends OfficeFloorServlet>
extends WebApplicationAutoWireOfficeFloorSource
implements WebAutoWireApplication

Servlet WebAutoWireApplication.

Author:

Daniel Sagenschneider

Nested Class Summary

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

AbstractOfficeFloorSource.SpecificationContext

Field Summary

Fields inherited from class net.officefloor.plugin.web.http.application.WebApplicationAutoWireOfficeFloorSource

processScopeWirer

Fields inherited from interface net.officefloor.plugin.web.http.application.WebAutoWireApplication

HANDLER_INPUT_NAME, HANDLER_SECTION_NAME, WEB_PUBLIC_RESOURCES_CLASS_PATH_PREFIX

Method Summary

Modifier and Type	Method and Description
static void	configure(OfficeFloorServlet servletInitiateInstance, javax.servlet.ServletContext servletContext) Configures the OfficeFloorServlet implementation into the ServletContext.
void	destroy() Destroys this ServletWebAutoWireApplication.
static <I extends OfficeFloorServlet> ServletWebAutoWireApplication<I>	initiate(I servletInstance) Initiates and returns the ServletWebAutoWireApplication for the OfficeFloorServlet instance.
void	linkEscalation(Class<? extends Throwable> escalation, String resourcePath) Links the Escalation to be handled by the resource.
void	linkToResource(AutoWireSection section, String outputName, String requestDispatcherPath) Links to a resource.
static void	reset() Resets the registered ServletWebAutoWireApplication instances.
boolean	service(S servletInstance, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Services the HttpServletRequest.

Methods inherited from class net.officefloor.plugin.web.http.application.WebApplicationAutoWireOfficeFloorSource

addHttpApplicationObject, addHttpApplicationObject, addHttpRequestObject, addHttpRequestObject, addHttpSessionObject, addHttpSessionObject, addHttpTemplate, chainServicer, getHttpSecurity, getTemplateSectionName, getURIs, initOfficeFloor, linkEscalation, linkToHttpTemplate, linkToSendResponse, linkUri, setDefaultHttpTemplateUriSuffix, setHttpSecurity

Methods inherited from class net.officefloor.autowire.impl.AutoWireOfficeFloorSource

addGovernance, addManagedObject, addObject, addSection, addSection, addSectionTransformer, addStartupFlow, addSupplier, assignDefaultTeam, assignTeam, getAppropriateAutoWire, getOfficeFloorCompiler, getSection, isLinked, isObjectAvailable, link, linkEscalation, loadSpecification, openOfficeFloor, setProfiler, sourceOfficeFloor, specifyConfigurationProperties

Methods inherited from class net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource

getSpecification

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.plugin.web.http.application.WebAutoWireApplication

addHttpApplicationObject, addHttpApplicationObject, addHttpRequestObject, addHttpRequestObject, addHttpSessionObject, addHttpSessionObject, addHttpTemplate, chainServicer, getHttpSecurity, getURIs, linkEscalation, linkToHttpTemplate, linkToSendResponse, linkUri, setDefaultHttpTemplateUriSuffix, setHttpSecurity

Methods inherited from interface net.officefloor.autowire.AutoWireApplication

addGovernance, addManagedObject, addObject, addSection, addSection, addSectionTransformer, addStartupFlow, addSupplier, assignDefaultTeam, assignTeam, getOfficeFloorCompiler, getSection, isLinked, isObjectAvailable, link, linkEscalation, openOfficeFloor, setProfiler

Method Detail

reset

public static void reset()

Resets the registered ServletWebAutoWireApplication instances.

This should NOT be called in Production and is only to reset for testing.

configure

public static void configure(OfficeFloorServlet servletInitiateInstance,
                             javax.servlet.ServletContext servletContext)

Configures the OfficeFloorServlet implementation into the ServletContext.

This is expected to be called from a ServletContextListener as it will configure an instance of the OfficeFloorServlet with appropriate URI mapping.

Parameters:

servletInitiateInstance - Implementing instance of the OfficeFloorServlet. This instance is only used used for registration and configuration. Its Class however is registered so that a new instance is instantiated and allows injection of necessary resources to occur.

servletContext - ServletContext.

initiate

public static <I extends OfficeFloorServlet> ServletWebAutoWireApplication<I> initiate(I servletInstance)
                                                                                throws javax.servlet.ServletException

Initiates and returns the ServletWebAutoWireApplication for the OfficeFloorServlet instance.

This is expected to be called from the Servlet.init(ServletConfig) so that the ServletConfig.getInitParameter(String) is available.

Type Parameters:

I - OfficeFloorServlet type.

Parameters:

servletInstance - OfficeFloorServlet instance.

Returns:

ServletWebAutoWireApplication for the OfficeFloorServlet instance after it has been initiated.

Throws:

javax.servlet.ServletException - If fails to initiate.

service

public boolean service(S servletInstance,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws javax.servlet.ServletException,
                       IOException

Services the HttpServletRequest.

Parameters:

servletInstance - OfficeFloorServlet instance.

request - HttpServletRequest.

response - HttpServletResponse.

Returns:

true if serviced or false indicating not handled.

Throws:

javax.servlet.ServletException - If fails to service HttpServletRequest.

IOException - If I/O failure in servicing the HttpServletRequest.

destroy

public void destroy()

Destroys this ServletWebAutoWireApplication.

linkToResource

public void linkToResource(AutoWireSection section,
                           String outputName,
                           String requestDispatcherPath)

Description copied from interface: WebAutoWireApplication

Links to a resource.

The meaning of resource path is specific to implementation.

Specified by:

linkToResource in interface WebAutoWireApplication

Overrides:

linkToResource in class WebApplicationAutoWireOfficeFloorSource

Parameters:

section - AutoWireSection.

outputName - Name of the OfficeSectionOutput.

requestDispatcherPath - Resource path.

linkEscalation

public void linkEscalation(Class<? extends Throwable> escalation,
                           String resourcePath)

Description copied from interface: WebAutoWireApplication

Links the Escalation to be handled by the resource.

Specified by:

linkEscalation in interface WebAutoWireApplication

Overrides:

linkEscalation in class WebApplicationAutoWireOfficeFloorSource

Parameters:

escalation - Escalation.

resourcePath - Resource path.