Polish `AbstractServletWebServerFactory`
Extract some of the utility methods to package private classespull/8496/merge
Phillip Webb
8 years ago
parent
b1c689b9b2
commit
9d61882bb1
@ -0,0 +1,148 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.web.servlet.server;
|
||||
|
||||
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;
|
||||
|
||||
/**
|
||||
* Manages a {@link ServletWebServerFactory} document root.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @see AbstractServletWebServerFactory
|
||||
*/
|
||||
class DocumentRoot {
|
||||
|
||||
private static final String[] COMMON_DOC_ROOTS = { "src/main/webapp", "public",
|
||||
"static" };
|
||||
|
||||
private final Log logger;
|
||||
|
||||
private File directory;
|
||||
|
||||
DocumentRoot(Log logger) {
|
||||
this.logger = logger;
|
||||
}
|
||||
|
||||
public File getDirectory() {
|
||||
return this.directory;
|
||||
}
|
||||
|
||||
public void setDirectory(File directory) {
|
||||
this.directory = directory;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the absolute document root when it points to a valid directory, logging a
|
||||
* warning and returning {@code null} otherwise.
|
||||
* @return the valid document root
|
||||
*/
|
||||
public final File getValidDirectory() {
|
||||
File file = this.directory;
|
||||
file = (file != null ? file : getWarFileDocumentRoot());
|
||||
file = (file != null ? file : getExplodedWarFileDocumentRoot());
|
||||
file = (file != null ? file : getCommonDocumentRoot());
|
||||
if (file == null && this.logger.isDebugEnabled()) {
|
||||
logNoDocumentRoots();
|
||||
}
|
||||
else if (this.logger.isDebugEnabled()) {
|
||||
this.logger.debug("Document root: " + file);
|
||||
}
|
||||
return file;
|
||||
}
|
||||
|
||||
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 getExplodedWarFileDocumentRoot() {
|
||||
return getExplodedWarFileDocumentRoot(getCodeSourceArchive());
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
}
|
||||
|
||||
public final File getExplodedWarFileDocumentRoot(File codeSourceFile) {
|
||||
if (this.logger.isDebugEnabled()) {
|
||||
this.logger.debug("Code archive: " + codeSourceFile);
|
||||
}
|
||||
if (codeSourceFile != null && codeSourceFile.exists()) {
|
||||
String path = codeSourceFile.getAbsolutePath();
|
||||
int webInfPathIndex = path
|
||||
.indexOf(File.separatorChar + "WEB-INF" + File.separatorChar);
|
||||
if (webInfPathIndex >= 0) {
|
||||
path = path.substring(0, webInfPathIndex);
|
||||
return new File(path);
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private File getCommonDocumentRoot() {
|
||||
for (String commonDocRoot : COMMON_DOC_ROOTS) {
|
||||
File root = new File(commonDocRoot);
|
||||
if (root.exists() && root.isDirectory()) {
|
||||
return root.getAbsoluteFile();
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private void logNoDocumentRoots() {
|
||||
this.logger.debug("None of the document roots " + Arrays.asList(COMMON_DOC_ROOTS)
|
||||
+ " point to a directory and will be ignored.");
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,59 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.web.servlet.server;
|
||||
|
||||
import java.io.File;
|
||||
|
||||
import org.springframework.boot.ApplicationHome;
|
||||
import org.springframework.boot.ApplicationTemp;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* Manages a session store directory.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
* @see AbstractServletWebServerFactory
|
||||
*/
|
||||
class SessionStoreDirectory {
|
||||
|
||||
private File directory;
|
||||
|
||||
public File getDirectory() {
|
||||
return this.directory;
|
||||
}
|
||||
|
||||
public void setDirectory(File directory) {
|
||||
this.directory = directory;
|
||||
}
|
||||
|
||||
public File getValidDirectory(boolean mkdirs) {
|
||||
File dir = getDirectory();
|
||||
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;
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,108 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.web.servlet.server;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.net.JarURLConnection;
|
||||
import java.net.URL;
|
||||
import java.net.URLClassLoader;
|
||||
import java.net.URLConnection;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.jar.JarFile;
|
||||
|
||||
/**
|
||||
* Logic to extract URLs of static resource jars (those containing
|
||||
* {@code "META-INF/resources"} directories).
|
||||
*
|
||||
* @author Andy Wilkinson
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
class StaticResourceJars {
|
||||
|
||||
public final List<URL> getUrls() {
|
||||
ClassLoader classLoader = getClass().getClassLoader();
|
||||
List<URL> urls = new ArrayList<>();
|
||||
if (classLoader instanceof URLClassLoader) {
|
||||
for (URL url : ((URLClassLoader) classLoader).getURLs()) {
|
||||
addUrl(urls, url);
|
||||
}
|
||||
}
|
||||
return urls;
|
||||
}
|
||||
|
||||
private void addUrl(List<URL> urls, URL url) {
|
||||
try {
|
||||
if ("file".equals(url.getProtocol())) {
|
||||
addUrlFile(urls, url, new File(url.getFile()));
|
||||
}
|
||||
else {
|
||||
addUrlConnection(urls, url, url.openConnection());
|
||||
}
|
||||
}
|
||||
catch (IOException ex) {
|
||||
throw new IllegalStateException(ex);
|
||||
}
|
||||
}
|
||||
|
||||
private void addUrlFile(List<URL> urls, URL url, File file) {
|
||||
if (file.isDirectory() && new File(file, "META-INF/resources").isDirectory()) {
|
||||
urls.add(url);
|
||||
}
|
||||
else if (isResourcesJar(file)) {
|
||||
urls.add(url);
|
||||
}
|
||||
}
|
||||
|
||||
private void addUrlConnection(List<URL> urls, URL url, URLConnection connection) {
|
||||
if (connection instanceof JarURLConnection) {
|
||||
if (isResourcesJar((JarURLConnection) connection)) {
|
||||
urls.add(url);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private boolean isResourcesJar(JarURLConnection connection) {
|
||||
try {
|
||||
return isResourcesJar(connection.getJarFile());
|
||||
}
|
||||
catch (IOException ex) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
private boolean isResourcesJar(File file) {
|
||||
try {
|
||||
return isResourcesJar(new JarFile(file));
|
||||
}
|
||||
catch (IOException ex) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
private boolean isResourcesJar(JarFile jar) throws IOException {
|
||||
try {
|
||||
return jar.getName().endsWith(".jar")
|
||||
&& (jar.getJarEntry("META-INF/resources") != null);
|
||||
}
|
||||
finally {
|
||||
jar.close();
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright 2012-2017 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.web.servlet.server;
|
||||
|
||||
import java.io.File;
|
||||
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.junit.Rule;
|
||||
import org.junit.Test;
|
||||
import org.junit.rules.TemporaryFolder;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Tests for {@link DocumentRoot}.
|
||||
*
|
||||
* @author Phillip Webb
|
||||
*/
|
||||
public class DocumentRootTests {
|
||||
|
||||
@Rule
|
||||
public TemporaryFolder temporaryFolder = new TemporaryFolder();
|
||||
|
||||
private DocumentRoot documentRoot = new DocumentRoot(LogFactory.getLog(getClass()));
|
||||
|
||||
@Test
|
||||
public void explodedWarFileDocumentRootWhenRunningFromExplodedWar() throws Exception {
|
||||
File webInfClasses = this.temporaryFolder.newFolder("test.war", "WEB-INF", "lib",
|
||||
"spring-boot.jar");
|
||||
File directory = this.documentRoot.getExplodedWarFileDocumentRoot(webInfClasses);
|
||||
assertThat(directory)
|
||||
.isEqualTo(webInfClasses.getParentFile().getParentFile().getParentFile());
|
||||
}
|
||||
|
||||
@Test
|
||||
public void explodedWarFileDocumentRootWhenRunningFromPackagedWar() throws Exception {
|
||||
File codeSourceFile = this.temporaryFolder.newFile("test.war");
|
||||
File directory = this.documentRoot.getExplodedWarFileDocumentRoot(codeSourceFile);
|
||||
assertThat(directory).isNull();
|
||||
}
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue