net.officefloor.plugin.servlet.container

Class HttpServletContainerImpl

java.lang.Object

net.officefloor.plugin.servlet.container.HttpServletContainerImpl

All Implemented Interfaces:

FilterChain, HttpServletContainer, HttpServletServicer

public class HttpServletContainerImpl
extends Object
implements HttpServletContainer, HttpServletServicer, FilterChain

HttpServletContainer implementation.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
HttpServletContainerImpl(String servletName, HttpServlet servlet, Map<String,String> initParameters, OfficeServletContext officeServletContext, net.officefloor.frame.api.manage.Office office, Clock clock, Locale defaultLocale) Initiate.

Method Summary

Modifier and Type	Method and Description
void	doFilter(ServletRequest request, ServletResponse response)
String[]	getServletMappings() Obtains the mappings that are handled by this HttpServletServicer.
String	getServletName() Obtains the name of this HttpServletServicer.
void	include(HttpServletRequest request, HttpServletResponse response) Includes the servicing of contained HttpServlet on the inputs.
void	include(OfficeServletContext context, HttpServletRequest request, HttpServletResponse response) Includes the content from this HttpServlet.
void	service(net.officefloor.plugin.socket.server.http.ServerHttpConnection connection, HttpRequestState attributes, HttpSession session, HttpServletSecurity security, net.officefloor.frame.api.execute.TaskContext<?,?,?> taskContext, ServicerMapping mapping) Services the HttpRequest of the ServerHttpConnection.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpServletContainerImpl

public HttpServletContainerImpl(String servletName,
                                HttpServlet servlet,
                                Map<String,String> initParameters,
                                OfficeServletContext officeServletContext,
                                net.officefloor.frame.api.manage.Office office,
                                Clock clock,
                                Locale defaultLocale)
                         throws ServletException

Initiate.

Parameters:

servletName - Name of the Servlet.

servlet - HttpServlet.

initParameters - Init parameters for the ServletConfig.

officeServletContext - OfficeServletContext.

office - Office.

clock - Clock.

defaultLocale - Default Locale.

Throws:

ServletException - If fails to initialise the HttpServlet.

Method Detail

service

public void service(net.officefloor.plugin.socket.server.http.ServerHttpConnection connection,
                    HttpRequestState attributes,
                    HttpSession session,
                    HttpServletSecurity security,
                    net.officefloor.frame.api.execute.TaskContext<?,?,?> taskContext,
                    ServicerMapping mapping)
             throws ServletException,
                    IOException

Description copied from interface: HttpServletContainer

Services the HttpRequest of the ServerHttpConnection.

Specified by:

service in interface HttpServletContainer

Parameters:

connection - ServerHttpConnection containing the HttpRequest to service.

attributes - HttpRequestState.

session - HttpSession for the HttpRequest.

security - HttpServletSecurity. May be null if anonymous HttpRequest.

taskContext - TaskContext to allow access to OfficeFloor capabilities.

mapping - ServicerMapping that mapped the HttpRequest to the HttpServlet. May be null if not mapped.

Throws:

ServletException - As per HttpServlet API.

IOException - As per HttpServlet API.

include

public void include(HttpServletRequest request,
                    HttpServletResponse response)
             throws ServletException,
                    IOException

Description copied from interface: HttpServletContainer

Includes the servicing of contained HttpServlet on the inputs.

Specified by:

include in interface HttpServletContainer

Parameters:

request - HttpServletRequest.

response - HttpServletResponse.

Throws:

ServletException - As per HttpServlet API.

IOException - As per HttpServlet API.

getServletName

public String getServletName()

Description copied from interface: HttpServletServicer

Obtains the name of this HttpServletServicer.

This will be used to find this HttpServletServicer by name.

Specified by:

getServletName in interface HttpServletServicer

Returns:

HttpServletServicer name.

getServletMappings

public String[] getServletMappings()

Description copied from interface: HttpServletServicer

Obtains the mappings that are handled by this HttpServletServicer.

The mappings are of the form:

1. /some/path.extension: for exact mapping (extension is optional)
2. /wild/card/*: for path wild card mapping
3. *.extension: for extension mapping

This follows the Servlet specification in regards to mappings.

Specified by:

getServletMappings in interface HttpServletServicer

Returns:

Mappings that are handled by this HttpServletServicer.

See Also:

ServicerMapper

include

public void include(OfficeServletContext context,
                    HttpServletRequest request,
                    HttpServletResponse response)
             throws ServletException,
                    IOException

Description copied from interface: HttpServletServicer

Includes the content from this HttpServlet.

Specified by:

include in interface HttpServletServicer

Parameters:

context - OfficeServletContext.

request - HttpServletRequest.

response - HttpServletResponse.

Throws:

ServletException - As per RequestDispatcher.

IOException - As per RequestDispatcher.

doFilter

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

Specified by:

doFilter in interface FilterChain

Throws:

IOException

ServletException