Java tutorial
/* * Copyright (c) 2008-2016 Haulmont. * * 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.haulmont.cuba.core.sys.remoting; import com.haulmont.cuba.core.global.AppBeans; import com.haulmont.cuba.core.global.Configuration; import com.haulmont.cuba.core.global.GlobalConfig; import com.haulmont.cuba.core.sys.AppContext; import com.haulmont.cuba.core.sys.CubaXmlWebApplicationContext; import com.haulmont.cuba.core.sys.RemotingContextHolder; import org.apache.commons.lang.StringUtils; import org.apache.commons.lang.text.StrTokenizer; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.context.ApplicationContext; import org.springframework.util.ResourceUtils; import org.springframework.web.context.WebApplicationContext; import org.springframework.web.servlet.DispatcherServlet; import org.springframework.web.servlet.ModelAndView; import javax.servlet.ServletConfig; import javax.servlet.ServletException; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import java.io.File; public class RemotingServlet extends DispatcherServlet { private static final long serialVersionUID = 4142366570614871805L; public static final String SPRING_CONTEXT_CONFIG = "cuba.remotingSpringContextConfig"; private static final Logger log = LoggerFactory.getLogger(RemotingServlet.class); private volatile boolean checkCompleted; /* The field is used to prevent double initialization of the servlet. Double initialization might occur during single WAR deployment when we call the method from initializer. */ protected volatile boolean initialized = false; @Override public String getContextConfigLocation() { String configProperty = AppContext.getProperty(SPRING_CONTEXT_CONFIG); if (StringUtils.isBlank(configProperty)) { throw new IllegalStateException("Missing " + SPRING_CONTEXT_CONFIG + " application property"); } File baseDir = new File(AppContext.getProperty("cuba.confDir")); StrTokenizer tokenizer = new StrTokenizer(configProperty); String[] tokenArray = tokenizer.getTokenArray(); StringBuilder locations = new StringBuilder(); for (String token : tokenArray) { String location; if (ResourceUtils.isUrl(token)) { location = token; } else { if (token.startsWith("/")) token = token.substring(1); File file = new File(baseDir, token); if (file.exists()) { location = file.toURI().toString(); } else { location = "classpath:" + token; } } locations.append(location).append(" "); } return locations.toString(); } @Override protected WebApplicationContext initWebApplicationContext() { WebApplicationContext wac = findWebApplicationContext(); if (wac == null) { ApplicationContext parent = AppContext.getApplicationContext(); wac = createWebApplicationContext(parent); } onRefresh(wac); // Publish the context as a servlet context attribute. String attrName = getServletContextAttributeName(); getServletContext().setAttribute(attrName, wac); if (this.logger.isDebugEnabled()) { this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() + "' as ServletContext attribute with name [" + attrName + "]"); } RemotingContextHolder.setRemotingApplicationContext(wac); LocalServiceDirectory.start(); return wac; } @Override protected void doService(HttpServletRequest request, HttpServletResponse response) throws Exception { checkConfiguration(request); RemoteClientInfo remoteClientInfo = new RemoteClientInfo(); remoteClientInfo.setAddress(request.getRemoteAddr()); remoteClientInfo.setHost(request.getRemoteHost()); remoteClientInfo.setPort(request.getRemotePort()); RemoteClientInfo.set(remoteClientInfo); try { super.doService(request, response); } finally { RemoteClientInfo.clear(); } } /** * Check correctness of some configuration parameters and log the warning if necessary. */ protected void checkConfiguration(HttpServletRequest request) { if (!checkCompleted) { GlobalConfig config = AppBeans.get(Configuration.class).getConfig(GlobalConfig.class); if (config.getLogIncorrectWebAppPropertiesEnabled()) { StringBuilder sb = new StringBuilder(); if (!request.getServerName().equals(config.getWebHostName())) { sb.append("***** cuba.webHostName=").append(config.getWebHostName()).append(", actual=") .append(request.getServerName()).append("\n"); } if (request.getServerPort() != Integer.parseInt(config.getWebPort())) { sb.append("***** cuba.webPort=").append(config.getWebPort()).append(", actual=") .append(request.getServerPort()).append("\n"); } String contextPath = request.getContextPath(); if (contextPath.startsWith("/")) contextPath = contextPath.substring(1); if (!contextPath.equals(config.getWebContextName())) { sb.append("***** cuba.webContextName=").append(config.getWebContextName()).append(", actual=") .append(contextPath).append("\n"); } if (sb.length() > 0) { sb.insert(0, "\n*****\n"); sb.append("*****"); log.warn(" Invalid configuration parameters that may cause problems:" + sb.toString()); } } checkCompleted = true; } } @Override protected ModelAndView processHandlerException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { log.error("Error processing request", ex); return super.processHandlerException(request, response, handler, ex); } @Override public void init(ServletConfig config) throws ServletException { if (!initialized) { super.init(config); initialized = true; } } @Override public Class<?> getContextClass() { return CubaXmlWebApplicationContext.class; } }