com.webmethods.caf.faces.servlet

Class CAFFacesServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.webmethods.caf.faces.servlet.CAFFacesServlet

All Implemented Interfaces:

Serializable, Servlet, ServletConfig

public class CAFFacesServlet
extends HttpServlet

Faces servlet.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	INIT_PARAM_FOOT
static String	INIT_PARAM_HEAD
protected Application	m_application
protected FacesContextFactory	m_facesContextFactory
protected String	m_foot
protected String	m_head
protected Lifecycle	m_lifecycle
protected ServletConfig	m_servletConfig

Constructor Summary

Constructors

Constructor and Description
CAFFacesServlet()

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForAllowedMethod(HttpServletRequest request, HttpServletResponse response) Check the request method to see if it is one of the allowed methods.
void	destroy()
void	init(ServletConfig servletConfig)
protected void	renderDefaultFoot(HttpServletRequest request, HttpServletResponse response, FacesContext context)
protected void	renderDefaultHead(HttpServletRequest request, HttpServletResponse response, FacesContext context) Auxiliary method for renderHead().
protected void	renderFoot(HttpServletRequest request, HttpServletResponse response, FacesContext context)
protected void	renderHead(HttpServletRequest request, HttpServletResponse response, FacesContext context) Auxiliary method for service().
protected void	service(HttpServletRequest request, HttpServletResponse response)
protected boolean	shouldSkipRenderPhaseForHeadRequest() Return true if a HEAD request should skip the render response phase.

Methods inherited from class javax.servlet.http.HttpServlet

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

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

INIT_PARAM_HEAD

public static final String INIT_PARAM_HEAD

See Also:

Constant Field Values

INIT_PARAM_FOOT

public static final String INIT_PARAM_FOOT

See Also:

Constant Field Values

m_application

protected Application m_application

m_facesContextFactory

protected FacesContextFactory m_facesContextFactory

m_lifecycle

protected Lifecycle m_lifecycle

m_servletConfig

protected ServletConfig m_servletConfig

m_head

protected String m_head

m_foot

protected String m_foot

Constructor Detail

CAFFacesServlet

public CAFFacesServlet()

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface Servlet

Overrides:

destroy in class GenericServlet

init

public void init(ServletConfig servletConfig)
          throws ServletException

Specified by:

init in interface Servlet

Overrides:

init in class GenericServlet

Throws:

ServletException

checkForAllowedMethod

protected boolean checkForAllowedMethod(HttpServletRequest request,
                                        HttpServletResponse response)

Check the request method to see if it is one of the allowed methods. If not a 405 error is returned.

shouldSkipRenderPhaseForHeadRequest

protected boolean shouldSkipRenderPhaseForHeadRequest()

Return true if a HEAD request should skip the render response phase. By default this returns true. A webapp can override this method if the HEAD request needs to be handled in some custom way.

Returns:

true to skip render false otherwise

service

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

Overrides:

service in class HttpServlet

Throws:

IOException

ServletException

renderHead

protected void renderHead(HttpServletRequest request,
                          HttpServletResponse response,
                          FacesContext context)
                   throws IOException,
                          ServletException

Auxiliary method for service(). Adds some tags to the beginning of the returned HTML.

Throws:

IOException

ServletException

renderDefaultHead

protected void renderDefaultHead(HttpServletRequest request,
                                 HttpServletResponse response,
                                 FacesContext context)
                          throws IOException

Auxiliary method for renderHead(). Adds the tags and page_parameters to the beginning of the returned HTML.

Throws:

IOException

renderFoot

protected void renderFoot(HttpServletRequest request,
                          HttpServletResponse response,
                          FacesContext context)
                   throws IOException,
                          ServletException

Throws:

IOException

ServletException

renderDefaultFoot

protected void renderDefaultFoot(HttpServletRequest request,
                                 HttpServletResponse response,
                                 FacesContext context)
                          throws IOException

Throws:

IOException