Class FTP.FTPDirectoryScanner

java.lang.Object

org.apache.tools.ant.DirectoryScanner

org.apache.tools.ant.taskdefs.optional.net.FTP.FTPDirectoryScanner

All Implemented Interfaces:

FileScanner, ResourceFactory, SelectorScanner

Enclosing class:

FTP

protected class FTP.FTPDirectoryScanner
extends DirectoryScanner

internal class allowing to read the contents of a remote file system using the FTP protocol used in particular for ftp get operations differences with DirectoryScanner "" (the root of the fileset) is never included in the included directories followSymlinks defaults to false

Since:

Ant 1.3

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	FTP.FTPDirectoryScanner.AntFTPFile	an AntFTPFile is a representation of a remote file
protected class	FTP.FTPDirectoryScanner.AntFTPRootFile	special class to represent the remote directory itself

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.commons.net.ftp.FTPClient	ftp

Fields inherited from class DirectoryScanner

basedir, DEFAULTEXCLUDES, dirsDeselected, dirsExcluded, dirsIncluded, dirsNotIncluded, DOES_NOT_EXIST_POSTFIX, errorOnMissingDir, everythingIncluded, excludes, filesDeselected, filesExcluded, filesIncluded, filesNotIncluded, haveSlowResults, includes, isCaseSensitive, MAX_LEVELS_OF_SYMLINKS, selectors

Modifier and Type	Field	Description
protected File	basedir	The base directory to be scanned.
protected static final String[]	DEFAULTEXCLUDES	Deprecated. since 1.6.x.
protected Vector<String>	dirsDeselected	The directories which matched at least one include and no excludes but which a selector discarded.
protected Vector<String>	dirsExcluded	The directories which matched at least one include and at least one exclude.
protected Vector<String>	dirsIncluded	The directories which matched at least one include and no excludes and were selected.
protected Vector<String>	dirsNotIncluded	The directories which were found and did not match any includes.
static final String	DOES_NOT_EXIST_POSTFIX	The end of the exception message if something that should be there doesn't exist.
protected boolean	errorOnMissingDir	Whether a missing base directory is an error.
protected boolean	everythingIncluded	Whether or not everything tested so far has been included.
protected String[]	excludes	The patterns for the files to be excluded.
protected Vector<String>	filesDeselected	The files which matched at least one include and no excludes and which a selector discarded.
protected Vector<String>	filesExcluded	The files which matched at least one include and at least one exclude.
protected Vector<String>	filesIncluded	The files which matched at least one include and no excludes and were selected.
protected Vector<String>	filesNotIncluded	The files which did not match any includes or selectors.
protected boolean	haveSlowResults	Whether or not our results were built by a slow scan.
protected String[]	includes	The patterns for the files to be included.
protected boolean	isCaseSensitive	Whether or not the file system should be treated as a case sensitive one.
static final int	MAX_LEVELS_OF_SYMLINKS	default value for maxLevelsOfSymlinks
protected FileSelector[]	selectors	Selectors that will filter which files are in our candidate list.

Constructor Summary

Constructors

Constructor	Description
FTPDirectoryScanner(org.apache.commons.net.ftp.FTPClient ftp)	constructor

Method Summary

Modifier and Type	Method	Description
org.apache.commons.net.ftp.FTPFile[]	listFiles(String directory)	cd into one directory and list the files present in one directory.
org.apache.commons.net.ftp.FTPFile[]	listFiles(String directory, boolean changedir)	list the files present in one directory.
void	scan()	scans the remote directory, storing internally the included files, directories, ...
protected void	scandir(String dir, String vpath, boolean fast)	scans a particular directory.

Methods inherited from class DirectoryScanner

addDefaultExclude, addDefaultExcludes, addExcludes, clearResults, couldHoldIncluded, getBasedir, getDefaultExcludes, getDeselectedDirectories, getDeselectedFiles, getExcludedDirectories, getExcludedFiles, getIncludedDirectories, getIncludedDirsCount, getIncludedFiles, getIncludedFilesCount, getNotFollowedSymlinks, getNotIncludedDirectories, getNotIncludedFiles, getResource, isCaseSensitive, isEverythingIncluded, isExcluded, isFollowSymlinks, isIncluded, isSelected, match, match, matchPath, matchPath, matchPatternStart, matchPatternStart, removeDefaultExclude, resetDefaultExcludes, scandir, setBasedir, setBasedir, setCaseSensitive, setErrorOnMissingDir, setExcludes, setFollowSymlinks, setIncludes, setMaxLevelsOfSymlinks, setSelectors, slowScan

Modifier and Type	Method	Description
static boolean	addDefaultExclude(String s)	Add a pattern to the default excludes unless it is already a default exclude.
void	addDefaultExcludes()	Add default exclusions to the current exclusions set.
void	addExcludes(String[] excludes)	Add to the list of exclude patterns to use.
protected void	clearResults()	Clear the result caches for a scan.
protected boolean	couldHoldIncluded(String name)	Test whether or not a name matches the start of at least one include pattern.
File	getBasedir()	Return the base directory to be scanned.
static String[]	getDefaultExcludes()	Get the list of patterns that should be excluded by default.
String[]	getDeselectedDirectories()	Return the names of the directories which were selected out and therefore not ultimately included.
String[]	getDeselectedFiles()	Return the names of the files which were selected out and therefore not ultimately included.
String[]	getExcludedDirectories()	Return the names of the directories which matched at least one of the include patterns and at least one of the exclude patterns.
String[]	getExcludedFiles()	Return the names of the files which matched at least one of the include patterns and at least one of the exclude patterns.
String[]	getIncludedDirectories()	Return the names of the directories which matched at least one of the include patterns and none of the exclude patterns.
int	getIncludedDirsCount()	Return the count of included directories.
String[]	getIncludedFiles()	Return the names of the files which matched at least one of the include patterns and none of the exclude patterns.
int	getIncludedFilesCount()	Return the count of included files.
String[]	getNotFollowedSymlinks()	Absolute paths of all symbolic links or Windows junctions that haven't been followed but would have been followed had followsymlinks been true or maxLevelsOfSymlinks been bigger.
String[]	getNotIncludedDirectories()	Return the names of the directories which matched none of the include patterns.
String[]	getNotIncludedFiles()	Return the names of the files which matched none of the include patterns.
Resource	getResource(String name)	Get the named resource.
boolean	isCaseSensitive()	Find out whether include exclude patterns are matched in a case sensitive way.
boolean	isEverythingIncluded()	Return whether or not the scanner has included all the files or directories it has come across so far.
protected boolean	isExcluded(String name)	Test whether or not a name matches against at least one exclude pattern.
boolean	isFollowSymlinks()	Get whether or not a DirectoryScanner follows symbolic links or Windows junctions.
protected boolean	isIncluded(String name)	Test whether or not a name matches against at least one include pattern.
protected boolean	isSelected(String name, File file)	Test whether a file should be selected.
static boolean	match(String pattern, String str)	Test whether or not a string matches against a pattern.
protected static boolean	match(String pattern, String str, boolean isCaseSensitive)	Test whether or not a string matches against a pattern.
protected static boolean	matchPath(String pattern, String str)	Test whether or not a given path matches a given pattern.
protected static boolean	matchPath(String pattern, String str, boolean isCaseSensitive)	Test whether or not a given path matches a given pattern.
protected static boolean	matchPatternStart(String pattern, String str)	Test whether or not a given path matches the start of a given pattern up to the first "**".
protected static boolean	matchPatternStart(String pattern, String str, boolean isCaseSensitive)	Test whether or not a given path matches the start of a given pattern up to the first "**".
static boolean	removeDefaultExclude(String s)	Remove a string if it is a default exclude.
static void	resetDefaultExcludes()	Go back to the hardwired default exclude patterns.
protected void	scandir(File dir, String vpath, boolean fast)	Scan the given directory for files and directories.
void	setBasedir(File basedir)	Set the base directory to be scanned.
void	setBasedir(String basedir)	Set the base directory to be scanned.
void	setCaseSensitive(boolean isCaseSensitive)	Set whether or not include and exclude patterns are matched in a case sensitive way.
void	setErrorOnMissingDir(boolean errorOnMissingDir)	Sets whether or not a missing base directory is an error
void	setExcludes(String[] excludes)	Set the list of exclude patterns to use.
void	setFollowSymlinks(boolean followSymlinks)	Set whether or not symbolic links or Windows junctions should be followed.
void	setIncludes(String[] includes)	Set the list of include patterns to use.
void	setMaxLevelsOfSymlinks(int max)	The maximum number of times a symbolic link or Windows junctions may be followed during a scan.
void	setSelectors(FileSelector[] selectors)	Set the selectors that will select the filelist.
protected void	slowScan()	Top level invocation for a slow scan.

Methods inherited from class Object

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

Field Details

ftp

protected org.apache.commons.net.ftp.FTPClient ftp

Constructor Details

FTPDirectoryScanner

public FTPDirectoryScanner(org.apache.commons.net.ftp.FTPClient ftp)

constructor

Parameters:

ftp - ftpclient object

Method Details

scan

public void scan()

scans the remote directory, storing internally the included files, directories, ...

Specified by:

scan in interface FileScanner

Overrides:

scan in class DirectoryScanner

scandir

protected void scandir(String dir,
 String vpath,
 boolean fast)

scans a particular directory. populates the scannedDirs cache.

Parameters:

dir - directory to scan

vpath - relative path to the base directory of the remote fileset always ended with a File.separator

fast - seems to be always true in practice

listFiles

public org.apache.commons.net.ftp.FTPFile[] listFiles(String directory,
 boolean changedir)

list the files present in one directory.

Parameters:

directory - full path on the remote side

changedir - if true change to directory directory before listing

Returns:

array of FTPFile

listFiles

public org.apache.commons.net.ftp.FTPFile[] listFiles(String directory)

cd into one directory and list the files present in one directory.

Parameters:

directory - full path on the remote side

Returns:

array of FTPFile