alma.acs.util

Class AcsFileFinderForDirectories

java.lang.Object

alma.acs.util.AcsFileFinderForDirectories

public class AcsFileFinderForDirectories
extends java.lang.Object

Finds a specific file in the directory structure made up of logically overlaid directories with roots at $INTROOT, $INTLIST, $ACSROOT, as specified in the system property acs.system.path. Optionally also looks under $ACSDATA.

The first occurrence of a file is taken, so that "less permanent" root directories such as $INTROOT are preferred over more permanent dirs such as $ACSROOT.

Implementation note: We do not use AcsFileFinder because it would cache all files under the root directories, which is too much for our purpose.

Since:

ACS 10.2, see http://jira.alma.cl/browse/COMP-5690

Author:

hsommer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACSDATA_PATH_PROPERTYNAME
static java.lang.String	SEARCHPATH_PROPERTYNAME

Constructor Summary

Constructors

Constructor and Description
AcsFileFinderForDirectories(java.util.logging.Logger logger, boolean includeAcsdataDir) Creates an AcsFileFinderForDirectories that can be used for multiple file searches.

Method Summary

Modifier and Type	Method and Description
java.io.File	findFile(java.lang.String relativePath, java.lang.String fileName) Searches for a single file with a known name.
java.util.List<java.io.File>	findFiles(java.lang.String relativePath, java.io.FilenameFilter filter) More flexible file search, that allows the user to check the filename in the supplied filter callback, for example to return all "*.txt" files under a given relative directory "config/myBelovedTxtFiles".

Methods inherited from class java.lang.Object

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

Field Detail

SEARCHPATH_PROPERTYNAME

public static final java.lang.String SEARCHPATH_PROPERTYNAME

See Also:

Constant Field Values

ACSDATA_PATH_PROPERTYNAME

public static final java.lang.String ACSDATA_PATH_PROPERTYNAME

See Also:

Constant Field Values

Constructor Detail

AcsFileFinderForDirectories

public AcsFileFinderForDirectories(java.util.logging.Logger logger,
                                   boolean includeAcsdataDir)

Creates an AcsFileFinderForDirectories that can be used for multiple file searches.

Parameters:

logger -

includeAcsdataDir - If true then $ACSDATA is included in the list of root dirs, as the last chance for finding a file.

Method Detail

findFile

public java.io.File findFile(java.lang.String relativePath,
                             java.lang.String fileName)

Searches for a single file with a known name.

Parameters:

relativePath - The path underneath $INTROOT, $ACSROOT, for example "config" or "lib/oracle/hiddenJars" or "".

fileName - The file name (without path), e.g. "myConfigFile.txt".

Returns:

The file found, or null if it wasn't found.

Throws:

java.lang.NullPointerException - If fileName is null

findFiles

public java.util.List<java.io.File> findFiles(java.lang.String relativePath,
                                              java.io.FilenameFilter filter)

More flexible file search, that allows the user to check the filename in the supplied filter callback, for example to return all "*.txt" files under a given relative directory "config/myBelovedTxtFiles".

For performance reasons (and to get simpler code) the method findFile(String, String) should be used instead whenever the single file name is known.

Parameters:

relativePath - The path underneath $INTROOT, $ACSROOT, for example "config" or "lib/oracle/hiddenJars".

filter - Must decide which files match. The dir callback argument will be consistent with the relativePath and should not be considered in the FilenameFilter implementation that should focus only on the name parameter.

Returns:

The list of all files that matched the directory and filter, possibly empty. If a certain file appeared under more than one root directory (e.g. under both "$INTROOT/config/bla" and "$ACSROOT/config/bla") then the first occurrence (from the less permanent location) is taken.