net.officefloor.plugin.servlet.container
Interface HttpServletServicer

All Known Implementing Classes:
HttpServletContainerImpl, HttpServletTask

public interface HttpServletServicer

HttpServlet servicer that is also the differentiator type for a HttpServlet Task.

Author:
Daniel Sagenschneider

Method Summary
 String[] getServletMappings()
           Obtains the mappings that are handled by this HttpServletServicer.
 String getServletName()
           Obtains the name of this HttpServletServicer.
 void include(OfficeServletContext context, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Includes the content from this HttpServlet.
 

Method Detail

getServletName

String getServletName()

Obtains the name of this HttpServletServicer.

This will be used to find this HttpServletServicer by name.

Returns:
HttpServletServicer name.

getServletMappings

String[] getServletMappings()

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.

Returns:
Mappings that are handled by this HttpServletServicer.
See Also:
ServicerMapper

include

void include(OfficeServletContext context,
             javax.servlet.http.HttpServletRequest request,
             javax.servlet.http.HttpServletResponse response)
             throws javax.servlet.ServletException,
                    IOException
Includes the content from this HttpServlet.

Parameters:
context - OfficeServletContext.
request - HttpServletRequest.
response - HttpServletResponse.
Throws:
javax.servlet.ServletException - As per RequestDispatcher.
IOException - As per RequestDispatcher.


Copyright © 2005-2012. All Rights Reserved.