net.officefloor.plugin.servlet

Class OfficeFloorServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

net.officefloor.plugin.servlet.OfficeFloorServlet

All Implemented Interfaces:

Serializable, EventListener, Filter, Servlet, ServletConfig, ServletContextListener

public abstract class OfficeFloorServlet
extends HttpServlet
implements ServletContextListener, Filter

HttpServlet to service HttpServletRequest instances via WebAutoWireApplication.

To use this class:

1. Create an implementation
2. Configure the implementation into the Servlet application as a ServletContextListener.

Note that the implementation requires to be configured as a ServletContextListener (rather than a Servlet) as it configures itself with its appropriate request handling mappings.

Please also note that the instance used for the ServletContextListener is not the instance used as the HttpServlet. This is necessary as a new instance of the OfficeFloorServlet implementation is created by the Servlet container to allow it to manage dependency injection of resources.

This also implements Filter because many JEE Servlet implementations register their default Servlet to service resources before the ServletContextListener configuration of this OfficeFloorServlet. By also being a Filter servicing the same mappings it overcomes this issue.

Author:

Daniel Sagenschneider

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OfficeFloorServlet()

Method Summary

Modifier and Type	Method and Description
abstract boolean	configure(WebAutoWireApplication application, ServletContext servletContext) Provides configuration of the WebAutoWireApplication for this OfficeFloorServlet.
void	contextDestroyed(ServletContextEvent event)
void	contextInitialized(ServletContextEvent event)
void	destroy()
void	doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
String	getInitParameter(String name)
String	getServletInfo()
abstract String	getServletName() Obtains the name to register this Servlet.
abstract String	getTemplateUriSuffix() Obtains the HttpTemplate URI suffix.
void	init()
void	init(FilterConfig filterConfig)
protected void	service(HttpServletRequest request, HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameterNames, getServletConfig, getServletContext, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeFloorServlet

public OfficeFloorServlet()

Method Detail

getServletName

public abstract String getServletName()

Obtains the name to register this Servlet.

Specified by:

getServletName in interface ServletConfig

Overrides:

getServletName in class GenericServlet

Returns:

Name to register this Servlet.

getTemplateUriSuffix

public abstract String getTemplateUriSuffix()

Obtains the HttpTemplate URI suffix.

Must provide a URI suffix to enable Servlet mapping for link URL continuations.

Returns:

HttpTemplate URI suffix.

configure

public abstract boolean configure(WebAutoWireApplication application,
                                  ServletContext servletContext)
                           throws Exception

Provides configuration of the WebAutoWireApplication for this OfficeFloorServlet.

Parameters:

application - WebAutoWireApplication.

servletContext - ServletContext.

Returns:

true to load the OfficeFloorServlet. false does not configure it.

Throws:

Exception - If fails to configure.

contextInitialized

public void contextInitialized(ServletContextEvent event)

Specified by:

contextInitialized in interface ServletContextListener

contextDestroyed

public void contextDestroyed(ServletContextEvent event)

Specified by:

contextDestroyed in interface ServletContextListener

getServletInfo

public String getServletInfo()

Specified by:

getServletInfo in interface Servlet

Overrides:

getServletInfo in class GenericServlet

init

public void init()
          throws ServletException

Overrides:

init in class GenericServlet

Throws:

ServletException

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface ServletConfig

Overrides:

getInitParameter in class GenericServlet

service

protected void service(HttpServletRequest request,
                       HttpServletResponse response)
                throws ServletException,
                       IOException

Overrides:

service in class HttpServlet

Throws:

ServletException

IOException

destroy

public void destroy()

Specified by:

destroy in interface Filter

Specified by:

destroy in interface Servlet

Overrides:

destroy in class GenericServlet

init

public void init(FilterConfig filterConfig)
          throws ServletException

Specified by:

init in interface Filter

Throws:

ServletException

doFilter

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

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException