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.application.WebApplicationAutoWireOfficeFloorSource
              net.officefloor.plugin.servlet.OfficeFloorServletFilter

All Implemented Interfaces:

javax.servlet.Filter, OfficeFloorSource, AutoWireApplication, WebAutoWireApplication

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

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 interface net.officefloor.plugin.web.http.application.WebAutoWireApplication

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	linkEscalation(Class<? extends Throwable> escalation, String resourcePath)
void	linkToResource(AutoWireSection section, String outputName, String requestDispatcherPath)

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

addHttpApplicationObject, addHttpApplicationObject, addHttpParametersObject, addHttpRequestObject, addHttpRequestObject, addHttpSessionObject, addHttpSessionObject, addHttpTemplate, addHttpTemplate, getURIs, initOfficeFloor, linkEscalation, linkToHttpTemplate, linkToSendResponse, linkUri, setNonHandledServicer

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

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

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

addHttpApplicationObject, addHttpApplicationObject, addHttpParametersObject, addHttpRequestObject, addHttpRequestObject, addHttpSessionObject, addHttpSessionObject, addHttpTemplate, addHttpTemplate, getURIs, linkEscalation, linkToHttpTemplate, linkToSendResponse, linkUri, setNonHandledServicer

Methods inherited from interface net.officefloor.plugin.autowire.AutoWireApplication

addManagedObject, addObject, addSection, addSection, assignDefaultTeam, assignTeam, getOfficeFloorCompiler, isLinked, isObjectAvailable, link, linkEscalation, openOfficeFloor

Constructor Detail

OfficeFloorServletFilter

public OfficeFloorServletFilter()

Method Detail

getFilterConfig

protected javax.servlet.FilterConfig getFilterConfig()

Obtains the FilterConfig.

Returns:

FilterConfig.

configure

protected abstract void configure()
                           throws Exception

Provides configuration of this as a WebApplicationAutoWireOfficeFloorSource.

Throws:

Exception - If fails to configure.

linkToResource

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

Specified by:

linkToResource in interface WebAutoWireApplication

Overrides:

linkToResource in class WebApplicationAutoWireOfficeFloorSource

linkEscalation

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

Specified by:

linkEscalation in interface WebAutoWireApplication

Overrides:

linkEscalation in class 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