net.officefloor.plugin.servlet
Class OfficeFloorServletFilter

java.lang.Object
  net.officefloor.compile.spi.officefloor.source.impl.AbstractOfficeFloorSource
      net.officefloor.plugin.autowire.AutoWireOfficeFloorSource
          net.officefloor.plugin.web.http.server.WebApplicationAutoWireOfficeFloorSource
              net.officefloor.plugin.servlet.OfficeFloorServletFilter

All Implemented Interfaces:

javax.servlet.Filter, OfficeFloorSource

public abstract class OfficeFloorServletFilter
extends WebApplicationAutoWireOfficeFloorSource
implements javax.servlet.Filter

Filter to invoke processing within an OfficeFloor.

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.server.WebApplicationAutoWireOfficeFloorSource

HANDLER_INPUT_NAME, HANDLER_SECTION_NAME

Constructor Summary

OfficeFloorServletFilter()

Method Summary

protected abstract void	configure() Provides configuration of this as a WebApplicationAutoWireOfficeFloorSource.
void	destroy()
void	doFilter(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)
protected javax.servlet.FilterConfig	getFilterConfig() Obtains the FilterConfig.
void	init(javax.servlet.FilterConfig config)
void	linkToServletResource(AutoWireSection section, String outputName, String requestDispatcherPath) Links OfficeSectionOutput to a Servlet container resource.

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

addHttpTemplate, addHttpTemplate, getURIs, initOfficeFloor, linkToHttpTemplate, linkToSendResponse, linkUri, setNonHandledServicer

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

addManagedObject, addObject, addSection, assignDefaultTeam, assignTeam, getOfficeFloorCompiler, isLinked, link, loadSpecification, openOfficeFloor, 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

Constructor Detail

OfficeFloorServletFilter

public OfficeFloorServletFilter()

Method Detail

getFilterConfig

protected javax.servlet.FilterConfig getFilterConfig()

Obtains the FilterConfig.

Returns:

FilterConfig.

linkToServletResource

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

Links OfficeSectionOutput to a Servlet container resource.

Parameters:

section - AutoWireSection.

outputName - Name of the OfficeSectionOutput.

requestDispatcherPath - Path for the RequestDispatcher.

configure

protected abstract void configure()

Provides configuration of this as a WebApplicationAutoWireOfficeFloorSource.

init

public void init(javax.servlet.FilterConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

doFilter

public void doFilter(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter