/*
* $Id: FacesServlet.java,v 1.32 2007/01/29 07:29:01 rlubke Exp $
*/
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the License at
* https://javaserverfaces.dev.java.net/CDDL.html or
* legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permission and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* [Name of File] [ver.__] [Date]
*
* Copyright 2005 Sun Microsystems Inc. All Rights Reserved
*/
package javax.faces.webapp;
import java.io.IOException;
import javax.faces.FacesException;
import javax.faces.FactoryFinder;
import javax.faces.context.FacesContext;
import javax.faces.context.FacesContextFactory;
import javax.faces.lifecycle.Lifecycle;
import javax.faces.lifecycle.LifecycleFactory;
import javax.servlet.Servlet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* <p><strong>FacesServlet</strong> is a servlet that manages the request
* processing lifecycle for web applications that are utilizing JavaServer
* Faces to construct the user interface.</p>
*/
public final class FacesServlet implements Servlet {
/**
* <p>Context initialization parameter name for a comma delimited list
* of context-relative resource paths (in addition to
* <code>/WEB-INF/faces-config.xml</code> which is loaded automatically
* if it exists) containing JavaServer Faces configuration information.</p>
*/
public static final String CONFIG_FILES_ATTR =
"javax.faces.CONFIG_FILES";
/**
* <p>Context initialization parameter name for the lifecycle identifier
* of the {@link Lifecycle} instance to be utilized.</p>
*/
public static final String LIFECYCLE_ID_ATTR =
"javax.faces.LIFECYCLE_ID";
/**
* <p>Factory for {@link FacesContext} instances.</p>
*/
private FacesContextFactory facesContextFactory = null;
/**
* <p>The {@link Lifecycle} instance to use for request processing.</p>
*/
private Lifecycle lifecycle = null;
/**
* <p>The <code>ServletConfig</code> instance for this servlet.</p>
*/
private ServletConfig servletConfig = null;
/**
* <p>Release all resources acquired at startup time.</p>
*/
public void destroy() {
facesContextFactory = null;
lifecycle = null;
servletConfig = null;
}
/**
* <p>Return the <code>ServletConfig</code> instance for this servlet.</p>
*/
public ServletConfig getServletConfig() {
return (this.servletConfig);
}
/**
* <p>Return information about this Servlet.</p>
*/
public String getServletInfo() {
return (this.getClass().getName());
}
/**
* <p>Acquire the factory instances we will require.</p>
*
* @throws ServletException if, for any reason, the startup of
* this Faces application failed. This includes errors in the
* config file that is parsed before or during the processing of
* this <code>init()</code> method.
*/
public void init(ServletConfig servletConfig) throws ServletException {
// Save our ServletConfig instance
this.servletConfig = servletConfig;
// Acquire our FacesContextFactory instance
try {
facesContextFactory = (FacesContextFactory)
FactoryFinder.getFactory
(FactoryFinder.FACES_CONTEXT_FACTORY);
} catch (FacesException e) {
Throwable rootCause = e.getCause();
if (rootCause == null) {
throw e;
} else {
throw new ServletException(e.getMessage(), rootCause);
}
}
// Acquire our Lifecycle instance
try {
LifecycleFactory lifecycleFactory = (LifecycleFactory)
FactoryFinder.getFactory(FactoryFinder.LIFECYCLE_FACTORY);
String lifecycleId ;
// First look in the servlet init-param set
if (null == (lifecycleId = servletConfig.getInitParameter(LIFECYCLE_ID_ATTR))) {
// If not found, look in the context-param set
lifecycleId = servletConfig.getServletContext().getInitParameter
(LIFECYCLE_ID_ATTR);
}
if (lifecycleId == null) {
lifecycleId = LifecycleFactory.DEFAULT_LIFECYCLE;
}
lifecycle = lifecycleFactory.getLifecycle(lifecycleId);
} catch (FacesException e) {
Throwable rootCause = e.getCause();
if (rootCause == null) {
throw e;
} else {
throw new ServletException(e.getMessage(), rootCause);
}
}
}
/**
* <p>Process an incoming request, and create the corresponding
* response, by executing the request processing lifecycle.</p>
*
* <p>If the <code>request</code> and <code>response</code>
* arguments to this method are not instances of
* <code>HttpServletRequest</code> and
* <code>HttpServletResponse</code>, respectively, the results of
* invoking this method are undefined.</p>
*
* <p>This method must respond to requests that start with the
* following strings by invoking the <code>sendError</code> method
* on the response argument (cast to
* <code>HttpServletResponse</code>), passing the code
* <code>HttpServletResponse.SC_NOT_FOUND</code> as the
* argument. </p>
*
* <ul>
*
<pre><code>
/WEB-INF/
/WEB-INF
/META-INF/
/META-INF
</code></pre>
*
* </ul>
*
*
*
* @param request The servlet request we are processing
* @param response The servlet response we are creating
*
* @throws IOException if an input/output error occurs during processing
* @throws ServletException if a servlet error occurs during processing
*/
public void service(ServletRequest request,
ServletResponse response)
throws IOException, ServletException {
// If prefix mapped, then ensure requests for /WEB-INF are
// not processed.
String pathInfo = ((HttpServletRequest) request).getPathInfo();
if (pathInfo != null) {
pathInfo = pathInfo.toUpperCase();
if (pathInfo.startsWith("/WEB-INF/")
|| pathInfo.equals("/WEB-INF")
|| pathInfo.startsWith("/META-INF/")
|| pathInfo.equals("/META-INF")) {
((HttpServletResponse) response).
sendError(HttpServletResponse.SC_NOT_FOUND);
return;
}
}
// Acquire the FacesContext instance for this request
FacesContext context = facesContextFactory.getFacesContext
(servletConfig.getServletContext(), request, response, lifecycle);
// Execute the request processing lifecycle for this request
try {
lifecycle.execute(context);
lifecycle.render(context);
} catch (FacesException e) {
Throwable t = e.getCause();
if (t == null) {
throw new ServletException(e.getMessage(), e);
} else {
if (t instanceof ServletException) {
throw ((ServletException) t);
} else if (t instanceof IOException) {
throw ((IOException) t);
} else {
throw new ServletException(t.getMessage(), t);
}
}
}
finally {
// Release the FacesContext instance for this request
context.release();
}
}
}