com.aspectran.web.service.DefaultServletHttpRequestHandler Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2023 The Aspectran Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.aspectran.web.service;
import com.aspectran.core.util.logging.Logger;
import com.aspectran.core.util.logging.LoggerFactory;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
/**
* The Class DefaultServletHttpRequestHandler.
*/
public class DefaultServletHttpRequestHandler {
private static final Logger logger = LoggerFactory.getLogger(DefaultServletHttpRequestHandler.class);
/** Default Servlet name used by Tomcat, Jetty, JBoss, and Glassfish */
private static final String COMMON_DEFAULT_SERVLET_NAME = "default";
/** Default Servlet name used by Resin */
private static final String RESIN_DEFAULT_SERVLET_NAME = "resin-file";
/** Default Servlet name used by WebLogic */
private static final String WEBLOGIC_DEFAULT_SERVLET_NAME = "FileServlet";
/** Default Servlet name used by WebSphere */
private static final String WEBSPHERE_DEFAULT_SERVLET_NAME = "SimpleFileServlet";
/** Default Servlet name used by Google App Engine */
private static final String GAE_DEFAULT_SERVLET_NAME = "_ah_default";
/** Default Servlet name used by Jeus */
private static final String JEUS_DEFAULT_SERVLET_NAME = "WorkerServlet";
private final ServletContext servletContext;
private String defaultServletName;
public DefaultServletHttpRequestHandler(ServletContext servletContext) {
this.servletContext = servletContext;
lookupDefaultServletName(servletContext);
}
/**
* Gets the default servlet name.
*
* @return the default servlet name
*/
public String getDefaultServletName() {
return defaultServletName;
}
/**
* Set the name of the default Servlet to be forwarded to for static resource requests.
*
* @param defaultServletName the new default servlet name
*/
public void setDefaultServletName(String defaultServletName) {
this.defaultServletName = defaultServletName;
}
/**
* Lookup default servlet name.
*
* @param servletContext the servlet context
*/
private void lookupDefaultServletName(ServletContext servletContext) {
if (servletContext.getNamedDispatcher(COMMON_DEFAULT_SERVLET_NAME) != null) {
defaultServletName = COMMON_DEFAULT_SERVLET_NAME;
} else if (servletContext.getNamedDispatcher(RESIN_DEFAULT_SERVLET_NAME) != null) {
defaultServletName = RESIN_DEFAULT_SERVLET_NAME;
} else if (servletContext.getNamedDispatcher(WEBLOGIC_DEFAULT_SERVLET_NAME) != null) {
defaultServletName = WEBLOGIC_DEFAULT_SERVLET_NAME;
} else if (servletContext.getNamedDispatcher(WEBSPHERE_DEFAULT_SERVLET_NAME) != null) {
defaultServletName = WEBSPHERE_DEFAULT_SERVLET_NAME;
} else if (servletContext.getNamedDispatcher(GAE_DEFAULT_SERVLET_NAME) != null) {
defaultServletName = GAE_DEFAULT_SERVLET_NAME;
} else if (servletContext.getNamedDispatcher(JEUS_DEFAULT_SERVLET_NAME) != null) {
defaultServletName = JEUS_DEFAULT_SERVLET_NAME;
} else {
if (logger.isDebugEnabled()) {
logger.debug("Unable to locate the default servlet for serving static content. " +
"Please set the 'web.defaultServletName' property explicitly.");
}
}
}
/**
* Process the actual dispatching.
*
* @param request current HTTP servlet request
* @param response current HTTP servlet response
* @return true, if successful
* @throws ServletException the servlet exception
* @throws IOException if an input or output error occurs while the servlet is handling the HTTP request
*/
public boolean handleRequest(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
if (defaultServletName != null) {
RequestDispatcher rd = servletContext.getNamedDispatcher(defaultServletName);
if (rd == null) {
throw new IllegalStateException("A RequestDispatcher could not be located for the default servlet '" +
defaultServletName + "'");
}
rd.forward(request, response);
return true;
} else {
return false;
}
}
}