org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory.java Source code

Introduction

Here is the source code for org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory.java

Source

/*
 * Copyright 2012-2015 the original author or authors.
 *
 * 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 org.springframework.boot.context.embedded;

import java.io.File;
import java.io.IOException;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLConnection;
import java.security.CodeSource;
import java.util.Arrays;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.springframework.boot.ApplicationHome;
import org.springframework.boot.ApplicationTemp;
import org.springframework.util.Assert;

/**
 * Abstract base class for {@link EmbeddedServletContainerFactory} implementations.
 *
 * @author Phillip Webb
 * @author Dave Syer
 */
public abstract class AbstractEmbeddedServletContainerFactory extends AbstractConfigurableEmbeddedServletContainer
        implements EmbeddedServletContainerFactory {

    protected final Log logger = LogFactory.getLog(getClass());

    private static final String[] COMMON_DOC_ROOTS = { "src/main/webapp", "public", "static" };

    public AbstractEmbeddedServletContainerFactory() {
        super();
    }

    public AbstractEmbeddedServletContainerFactory(int port) {
        super(port);
    }

    public AbstractEmbeddedServletContainerFactory(String contextPath, int port) {
        super(contextPath, port);
    }

    /**
     * Returns the absolute document root when it points to a valid folder, logging a
     * warning and returning {@code null} otherwise.
     * @return the valid document root
     */
    protected final File getValidDocumentRoot() {
        File file = getDocumentRoot();
        // If document root not explicitly set see if we are running from a war archive
        file = file != null ? file : getWarFileDocumentRoot();
        // If not a war archive maybe it is an exploded war
        file = file != null ? file : getExplodedWarFileDocumentRoot();
        // Or maybe there is a document root in a well-known location
        file = file != null ? file : getCommonDocumentRoot();
        if (file == null && this.logger.isDebugEnabled()) {
            this.logger.debug("None of the document roots " + Arrays.asList(COMMON_DOC_ROOTS)
                    + " point to a directory and will be ignored.");
        } else if (this.logger.isDebugEnabled()) {
            this.logger.debug("Document root: " + file);
        }
        return file;
    }

    private File getExplodedWarFileDocumentRoot() {
        File file = getCodeSourceArchive();
        if (this.logger.isDebugEnabled()) {
            this.logger.debug("Code archive: " + file);
        }
        if (file != null && file.exists() && file.getAbsolutePath().contains("/WEB-INF/")) {
            String path = file.getAbsolutePath();
            path = path.substring(0, path.indexOf("/WEB-INF/"));
            return new File(path);
        }
        return null;
    }

    private File getWarFileDocumentRoot() {
        return getArchiveFileDocumentRoot(".war");
    }

    private File getArchiveFileDocumentRoot(String extension) {
        File file = getCodeSourceArchive();
        if (this.logger.isDebugEnabled()) {
            this.logger.debug("Code archive: " + file);
        }
        if (file != null && file.exists() && !file.isDirectory()
                && file.getName().toLowerCase().endsWith(extension)) {
            return file.getAbsoluteFile();
        }
        return null;
    }

    private File getCommonDocumentRoot() {
        for (String commonDocRoot : COMMON_DOC_ROOTS) {
            File root = new File(commonDocRoot);
            if (root != null && root.exists() && root.isDirectory()) {
                return root.getAbsoluteFile();
            }
        }
        return null;
    }

    private File getCodeSourceArchive() {
        try {
            CodeSource codeSource = getClass().getProtectionDomain().getCodeSource();
            URL location = (codeSource == null ? null : codeSource.getLocation());
            if (location == null) {
                return null;
            }
            String path = location.getPath();
            URLConnection connection = location.openConnection();
            if (connection instanceof JarURLConnection) {
                path = ((JarURLConnection) connection).getJarFile().getName();
            }
            if (path.indexOf("!/") != -1) {
                path = path.substring(0, path.indexOf("!/"));
            }
            return new File(path);
        } catch (IOException ex) {
            return null;
        }
    }

    protected final File getValidSessionStoreDir() {
        return getValidSessionStoreDir(true);
    }

    protected final File getValidSessionStoreDir(boolean mkdirs) {
        File dir = getSessionStoreDir();
        if (dir == null) {
            return new ApplicationTemp().getDir("servlet-sessions");
        }
        if (!dir.isAbsolute()) {
            dir = new File(new ApplicationHome().getDir(), dir.getPath());
        }
        if (!dir.exists() && mkdirs) {
            dir.mkdirs();
        }
        Assert.state(!mkdirs || dir.exists(), "Session dir " + dir + " does not exist");
        Assert.state(!dir.isFile(), "Session dir " + dir + " points to a file");
        return dir;
    }

    /**
     * Returns the absolute temp dir for given servlet container.
     * @param prefix servlet container name
     * @return The temp dir for given servlet container.
     */
    protected File createTempDir(String prefix) {
        try {
            File tempFolder = File.createTempFile(prefix + ".", "." + getPort());
            tempFolder.delete();
            tempFolder.mkdir();
            tempFolder.deleteOnExit();
            return tempFolder;
        } catch (IOException ex) {
            throw new EmbeddedServletContainerException(
                    "Unable to create tempdir. java.io.tmpdir is set to " + System.getProperty("java.io.tmpdir"),
                    ex);
        }
    }

}