Adding HomeBase to simplify file access logic between jetty.home and jetty.base
This commit is contained in:
Joakim Erdfelt
Greg Wilkins
parent
998f95bfc0
commit
46a94956ee
|
|
@ -0,0 +1,212 @@
|
|||
//
|
||||
// ========================================================================
|
||||
// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
|
||||
// ------------------------------------------------------------------------
|
||||
// All rights reserved. This program and the accompanying materials
|
||||
// are made available under the terms of the Eclipse Public License v1.0
|
||||
// and Apache License v2.0 which accompanies this distribution.
|
||||
//
|
||||
// The Eclipse Public License is available at
|
||||
// http://www.eclipse.org/legal/epl-v10.html
|
||||
//
|
||||
// The Apache License v2.0 is available at
|
||||
// http://www.opensource.org/licenses/apache2.0.php
|
||||
//
|
||||
// You may elect to redistribute this code under either of these licenses.
|
||||
// ========================================================================
|
||||
//
|
||||
|
||||
package org.eclipse.jetty.start;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.FileFilter;
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Arrays;
|
||||
import java.util.List;
|
||||
import java.util.Objects;
|
||||
|
||||
/**
|
||||
* File access for <code>${jetty.home}</code>, and optional <code>${jetty.base}</code>, directories
|
||||
*/
|
||||
public class HomeBase
|
||||
{
|
||||
private static class AllFilter implements FileFilter
|
||||
{
|
||||
public static final AllFilter INSTANCE = new AllFilter();
|
||||
|
||||
@Override
|
||||
public boolean accept(File pathname)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
private final File homeDir;
|
||||
private final File baseDir;
|
||||
|
||||
public HomeBase(File homeDir, File baseDir)
|
||||
{
|
||||
this.homeDir = homeDir;
|
||||
this.baseDir = baseDir;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replace/Shorten arbitrary path with property strings <code>"${jetty.home}"</code> or <code>"${jetty.base}"</code> where appropriate.
|
||||
*
|
||||
* @param path
|
||||
* the path to shorten
|
||||
* @return the potentially shortened path
|
||||
*/
|
||||
public String toShortForm(String path)
|
||||
{
|
||||
if (path == null)
|
||||
{
|
||||
return path;
|
||||
}
|
||||
|
||||
String value = homeDir.getAbsolutePath();
|
||||
|
||||
if (path.startsWith(value))
|
||||
{
|
||||
return "${jetty.home}" + path.substring(value.length());
|
||||
}
|
||||
|
||||
if (baseDir != null)
|
||||
{
|
||||
value = baseDir.getAbsolutePath();
|
||||
if (path.startsWith(value))
|
||||
{
|
||||
return "${jetty.base}" + path.substring(value.length());
|
||||
}
|
||||
}
|
||||
return path;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convenience method for <code>toShortForm(file.getCanonicalPath())</code>
|
||||
*/
|
||||
public String toShortForm(File path)
|
||||
{
|
||||
try
|
||||
{
|
||||
return toShortForm(path.getCanonicalPath());
|
||||
}
|
||||
catch (IOException ignore)
|
||||
{
|
||||
/* ignore */
|
||||
}
|
||||
return toShortForm(path.getAbsolutePath());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a specific file reference.
|
||||
* <p>
|
||||
* If file exists in <code>${jetty.base}</code>, return its reference, otherwise return the <code>${jetty.home}</code> references.
|
||||
*
|
||||
* @param relPath
|
||||
* the path to get.
|
||||
* @return the file references.
|
||||
*/
|
||||
public File getFile(String relPath)
|
||||
{
|
||||
String rpath = separators(relPath);
|
||||
|
||||
if (baseDir != null)
|
||||
{
|
||||
File file = new File(baseDir,rpath);
|
||||
if (file.exists())
|
||||
{
|
||||
return file;
|
||||
}
|
||||
}
|
||||
return new File(homeDir,rpath);
|
||||
}
|
||||
|
||||
public static String separators(String path)
|
||||
{
|
||||
StringBuilder ret = new StringBuilder();
|
||||
for (char c : path.toCharArray())
|
||||
{
|
||||
if ((c == '/') || (c == '\\'))
|
||||
{
|
||||
ret.append(File.separatorChar);
|
||||
}
|
||||
else
|
||||
{
|
||||
ret.append(c);
|
||||
}
|
||||
}
|
||||
return ret.toString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all of the files that are in a specific relative directory.
|
||||
* <p>
|
||||
* If the same found path exists in both <code>${jetty.base}</code> and <code>${jetty.home}</code>, then the one in <code>${jetty.base}</code> is returned
|
||||
* (it overrides the one in ${jetty.home})
|
||||
*
|
||||
* @param relPathToDirectory
|
||||
* the relative path to the directory
|
||||
* @return the list of files found.
|
||||
*/
|
||||
public List<File> listFiles(String relPathToDirectory)
|
||||
{
|
||||
return listFiles(relPathToDirectory,AllFilter.INSTANCE);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all of the files that are in a specific relative directory, with applied {@link FileFilter}
|
||||
* <p>
|
||||
* If the same found path exists in both <code>${jetty.base}</code> and <code>${jetty.home}</code>, then the one in <code>${jetty.base}</code> is returned
|
||||
* (it overrides the one in ${jetty.home})
|
||||
*
|
||||
* @param relPathToDirectory
|
||||
* the relative path to the directory
|
||||
* @param filter
|
||||
* the filter to use
|
||||
* @return the list of files found.
|
||||
*/
|
||||
public List<File> listFiles(String relPathToDirectory, FileFilter filter)
|
||||
{
|
||||
Objects.requireNonNull(filter,"FileFilter cannot be null");
|
||||
|
||||
File homePath = new File(homeDir,separators(relPathToDirectory));
|
||||
List<File> homeFiles = new ArrayList<>();
|
||||
homeFiles.addAll(Arrays.asList(homePath.listFiles(filter)));
|
||||
|
||||
if (baseDir != null)
|
||||
{
|
||||
// merge
|
||||
File basePath = new File(baseDir,separators(relPathToDirectory));
|
||||
File baseFiles[] = basePath.listFiles(filter);
|
||||
List<File> ret = new ArrayList<>();
|
||||
|
||||
for (File base : baseFiles)
|
||||
{
|
||||
String relpath = toRelativePath(baseDir,base);
|
||||
File home = new File(homeDir,separators(relpath));
|
||||
if (home.exists())
|
||||
{
|
||||
homeFiles.remove(home);
|
||||
}
|
||||
ret.add(base);
|
||||
}
|
||||
|
||||
// add any remaining home files.
|
||||
ret.addAll(homeFiles);
|
||||
|
||||
return ret;
|
||||
}
|
||||
else
|
||||
{
|
||||
// simple return
|
||||
return homeFiles;
|
||||
}
|
||||
}
|
||||
|
||||
private String toRelativePath(File dir, File path)
|
||||
{
|
||||
return dir.toURI().relativize(path.toURI()).toASCIIString();
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,115 @@
|
|||
//
|
||||
// ========================================================================
|
||||
// Copyright (c) 1995-2013 Mort Bay Consulting Pty. Ltd.
|
||||
// ------------------------------------------------------------------------
|
||||
// All rights reserved. This program and the accompanying materials
|
||||
// are made available under the terms of the Eclipse Public License v1.0
|
||||
// and Apache License v2.0 which accompanies this distribution.
|
||||
//
|
||||
// The Eclipse Public License is available at
|
||||
// http://www.eclipse.org/legal/epl-v10.html
|
||||
//
|
||||
// The Apache License v2.0 is available at
|
||||
// http://www.opensource.org/licenses/apache2.0.php
|
||||
//
|
||||
// You may elect to redistribute this code under either of these licenses.
|
||||
// ========================================================================
|
||||
//
|
||||
|
||||
package org.eclipse.jetty.start;
|
||||
|
||||
import static org.hamcrest.Matchers.*;
|
||||
|
||||
import java.io.File;
|
||||
import java.io.IOException;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
import org.eclipse.jetty.toolchain.test.IO;
|
||||
import org.eclipse.jetty.toolchain.test.MavenTestingUtils;
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
|
||||
public class HomeBaseTest
|
||||
{
|
||||
private void assertFileList(HomeBase hb, String message, List<String> expected, List<File> files)
|
||||
{
|
||||
List<String> actual = new ArrayList<>();
|
||||
for (File file : files)
|
||||
{
|
||||
actual.add(hb.toShortForm(file));
|
||||
}
|
||||
Assert.assertThat(message,actual,containsInAnyOrder(expected.toArray()));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetFile_OnlyHome() throws IOException
|
||||
{
|
||||
File homeDir = MavenTestingUtils.getTestResourceDir("hb.1/home");
|
||||
File baseDir = null;
|
||||
|
||||
HomeBase hb = new HomeBase(homeDir,baseDir);
|
||||
File startIni = hb.getFile("/start.ini");
|
||||
|
||||
String ref = hb.toShortForm(startIni);
|
||||
Assert.assertThat("Reference",ref,startsWith("${jetty.home}"));
|
||||
|
||||
String contents = IO.readToString(startIni);
|
||||
Assert.assertThat("Contents",contents,containsString("Home Ini"));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testListFiles_OnlyHome() throws IOException
|
||||
{
|
||||
File homeDir = MavenTestingUtils.getTestResourceDir("hb.1/home");
|
||||
File baseDir = null;
|
||||
|
||||
HomeBase hb = new HomeBase(homeDir,baseDir);
|
||||
List<File> files = hb.listFiles("/start.d");
|
||||
|
||||
List<String> expected = new ArrayList<>();
|
||||
expected.add("${jetty.home}/start.d/jmx.ini");
|
||||
expected.add("${jetty.home}/start.d/jndi.ini");
|
||||
expected.add("${jetty.home}/start.d/jsp.ini");
|
||||
expected.add("${jetty.home}/start.d/logging.ini");
|
||||
expected.add("${jetty.home}/start.d/ssl.ini");
|
||||
|
||||
assertFileList(hb,"Files found",expected,files);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testListFiles_Both() throws IOException
|
||||
{
|
||||
File homeDir = MavenTestingUtils.getTestResourceDir("hb.1/home");
|
||||
File baseDir = MavenTestingUtils.getTestResourceDir("hb.1/base");
|
||||
|
||||
HomeBase hb = new HomeBase(homeDir,baseDir);
|
||||
List<File> files = hb.listFiles("/start.d");
|
||||
|
||||
List<String> expected = new ArrayList<>();
|
||||
expected.add("${jetty.base}/start.d/jmx.ini");
|
||||
expected.add("${jetty.home}/start.d/jndi.ini");
|
||||
expected.add("${jetty.home}/start.d/jsp.ini");
|
||||
expected.add("${jetty.base}/start.d/logging.ini");
|
||||
expected.add("${jetty.home}/start.d/ssl.ini");
|
||||
expected.add("${jetty.base}/start.d/myapp.ini");
|
||||
|
||||
assertFileList(hb,"Files found",expected,files);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetFile_Both() throws IOException
|
||||
{
|
||||
File homeDir = MavenTestingUtils.getTestResourceDir("hb.1/home");
|
||||
File baseDir = MavenTestingUtils.getTestResourceDir("hb.1/base");
|
||||
|
||||
HomeBase hb = new HomeBase(homeDir,baseDir);
|
||||
File startIni = hb.getFile("/start.ini");
|
||||
|
||||
String ref = hb.toShortForm(startIni);
|
||||
Assert.assertThat("Reference",ref,startsWith("${jetty.base}"));
|
||||
|
||||
String contents = IO.readToString(startIni);
|
||||
Assert.assertThat("Contents",contents,containsString("Base Ini"));
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1 @@
|
|||
# Base Logging
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
#===========================================================
|
||||
# Base Ini
|
||||
#===========================================================
|
||||
|
||||
OPTIONS=jmx
|
||||
etc/jetty-jmx.xml
|
||||
|
||||
|
|
@ -0,0 +1 @@
|
|||
# Home Logging
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
#===========================================================
|
||||
# Home Ini
|
||||
#===========================================================
|
||||
|
||||
OPTIONS=Server,jsp,resources,websocket,ext
|
||||
etc/jetty.xml
|
||||
start.d/
|
||||
etc/jetty-deploy.xml
|
||||
etc/jetty-webapps.xml
|
||||
etc/jetty-contexts.xml
|
||||
|
||||
Loading…
Reference in New Issue