org.eclipse.jetty.start

Class BaseHome

java.lang.Object

org.eclipse.jetty.start.BaseHome

public class BaseHome
extends Object

File access for ${jetty.home}, ${jetty.base}, directories.

By default, both ${jetty.home} and ${jetty.base} are the same directory, but they can point at different directories.

The ${jetty.home} directory is where the main Jetty binaries and default configuration is housed.

The ${jetty.base} directory is where the execution specific configuration and webapps are obtained from.

Constructor Summary

Constructors

Constructor and Description
BaseHome()
BaseHome(File homeDir, File baseDir)

Method Summary

Methods

Modifier and Type	Method and Description
String	getBase()
File	getBaseDir()
File	getBaseFile(String path) Create a file reference to some content in "${jetty.base}"
File	getFile(String path) Get a specific file reference.
String	getHome()
File	getHomeDir()
void	initialize(StartArgs args)
boolean	isBaseDifferent()
List<File>	listFiles(String relPathToDirectory) Get all of the files that are in a specific relative directory.
List<File>	listFiles(String relPathToDirectory, FileFilter filter) Get all of the files that are in a specific relative directory, with applied FileFilter
List<File>	listFilesRegex(String regex) Get all of the files that are in a specific relative directory, with applied regex.
List<File>	rawListFiles(String relPathToDirectory, FileFilter filter) Collect the list of files in both ${jetty.base} and ${jetty.home}, even if the same file shows up in both places.
void	setBaseDir(File dir)
void	setHomeDir(File dir)
String	toShortForm(File path) Convenience method for toShortForm(file.getCanonicalPath())
String	toShortForm(String path) Replace/Shorten arbitrary path with property strings "${jetty.home}" or "${jetty.base}" where appropriate.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseHome

public BaseHome()

BaseHome

public BaseHome(File homeDir,
        File baseDir)

Method Detail

getBase

public String getBase()

getBaseDir

public File getBaseDir()

getBaseFile

public File getBaseFile(String path)

Create a file reference to some content in "${jetty.base}"

Parameters:

path - the path to reference

Returns:

the file reference

getFile

public File getFile(String path)

Get a specific file reference.

File references go through 3 possibly scenarios.

1. If exists relative to ${jetty.base}, return that reference
2. If exists relative to ${jetty.home}, return that reference
3. Otherwise return absolute path reference

Parameters:

path - the path to get.

Returns:

the file reference.

getHome

public String getHome()

getHomeDir

public File getHomeDir()

initialize

public void initialize(StartArgs args)

isBaseDifferent

public boolean isBaseDifferent()

listFiles

public List<File> listFiles(String relPathToDirectory)

Get all of the files that are in a specific relative directory.

If the same found path exists in both ${jetty.base} and ${jetty.home}, then the one in ${jetty.base} is returned (it overrides the one in ${jetty.home})

Parameters:

relPathToDirectory - the relative path to the directory

Returns:

the list of files found.

listFiles

public List<File> listFiles(String relPathToDirectory,
                   FileFilter filter)

Get all of the files that are in a specific relative directory, with applied FileFilter

If the same found path exists in both ${jetty.base} and ${jetty.home}, then the one in ${jetty.base} is returned (it overrides the one in ${jetty.home})

Parameters:

relPathToDirectory - the relative path to the directory

filter - the filter to use

Returns:

the list of files found.

listFilesRegex

public List<File> listFilesRegex(String regex)

Get all of the files that are in a specific relative directory, with applied regex.

If the same found path exists in both ${jetty.base} and ${jetty.home}, then the one in ${jetty.base} is returned (it overrides the one in ${jetty.home})

All regex paths are assumed to be in unix notation (use of "/" to separate paths, as "\" is used to escape in regex)

Parameters:

regex - the regex to use to match against the found files.

Returns:

the list of files found.

rawListFiles

public List<File> rawListFiles(String relPathToDirectory,
                      FileFilter filter)

Collect the list of files in both ${jetty.base} and ${jetty.home}, even if the same file shows up in both places.

setBaseDir

public void setBaseDir(File dir)

setHomeDir

public void setHomeDir(File dir)

toShortForm

public String toShortForm(File path)

Convenience method for toShortForm(file.getCanonicalPath())

toShortForm

public String toShortForm(String path)

Replace/Shorten arbitrary path with property strings "${jetty.home}" or "${jetty.base}" where appropriate.

Parameters:

path - the path to shorten

Returns:

the potentially shortened path