org.safs.tools.drivers

Class ConfigureFileLocator

java.lang.Object

org.safs.tools.drivers.ConfigureFileLocator

All Implemented Interfaces:

ConfigureLocatorInterface

public class ConfigureFileLocator
extends java.lang.Object
implements ConfigureLocatorInterface

Field Summary

Fields

Modifier and Type	Field and Description
(package private) java.io.File	extractFile
protected java.util.Vector<java.lang.String>	paths
(package private) boolean	projectExtracted

Constructor Summary

Constructors

Constructor and Description
ConfigureFileLocator() Constructor for ConfigureLocator

Method Summary

Modifier and Type	Method and Description
CaseInsensitiveFile	extractConfigPath(java.lang.String rootDir, java.lang.String configPath) Extract project and test assets to a Temp directory if embedded inside a JAR file.
(package private) java.io.File	getExtractionDirectory() Deduce a Temp directory or user-specified extraction directory for JAR extraction.
ConfigureInterface	locateConfigureInterface(java.lang.String rootDir, java.lang.String configPath) Attempt to locate DRIVER configuration data.
java.io.File	locateRootDir(java.lang.String rootDir) Attempt to locate DRIVER root/install directory.
protected ConfigureInterface	uniqueConfigureInterface(java.io.File candidate) return a valid ConfigureInterface with the candidate path signature only once.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.safs.tools.drivers.ConfigureLocatorInterface

getConfigureLocator

Field Detail

paths

protected java.util.Vector<java.lang.String> paths

projectExtracted

boolean projectExtracted

extractFile

java.io.File extractFile

Constructor Detail

ConfigureFileLocator

public ConfigureFileLocator()

Constructor for ConfigureLocator

Method Detail

locateRootDir

public java.io.File locateRootDir(java.lang.String rootDir)

Description copied from interface: ConfigureLocatorInterface

Attempt to locate DRIVER root/install directory.

Specified by:

locateRootDir in interface ConfigureLocatorInterface

Parameters:

rootDir - -- The rootDir may be a String containing a path to a directory, or to a file, or to some other type of object as needed by the specific implementation.

Returns:

a File object or null if not located.

See Also:

ConfigureLocatorInterface.locateRootDir(String)

uniqueConfigureInterface

protected ConfigureInterface uniqueConfigureInterface(java.io.File candidate)

return a valid ConfigureInterface with the candidate path signature only once.

locateConfigureInterface

public ConfigureInterface locateConfigureInterface(java.lang.String rootDir,
                                                   java.lang.String configPath)

Description copied from interface: ConfigureLocatorInterface

Attempt to locate DRIVER configuration data.

Specified by:

locateConfigureInterface in interface ConfigureLocatorInterface

Parameters:

rootDir - -- The rootDir may be a String containing a path to a directory, or to a file, or to some other type of object as needed by the specific implementation.

configPath - -- The configPath may be a String containing a path to a directory, or to a file, or to some other type of object as needed by the specific implementation.

The rootDir and configPath may be used in combination to resolve to the ConfigureInterface.

Returns:

ConfigureInterface if located, or null if not.

See Also:

ConfigureLocatorInterface.locateConfigureInterface(String, String)

getExtractionDirectory

java.io.File getExtractionDirectory()
                             throws java.io.IOException

Deduce a Temp directory or user-specified extraction directory for JAR extraction.

The routine will seek the System.getProperty("safs.project.extract") to extract to an alternative directory instead of the Temp directory.

JVM Arg: -Dsafs.project.extract=<absolute path to extraction directory>

Returns:

File pointing to the desired extraction directory.

Throws:

java.io.IOException

extractConfigPath

public CaseInsensitiveFile extractConfigPath(java.lang.String rootDir,
                                             java.lang.String configPath)

Extract project and test assets to a Temp directory if embedded inside a JAR file.

The routine will seek the System.getProperty("safs.project.extract") to extract to an alternative directory instead of the Temp directory.

All assets should be stored in rootDir that exists in JAR file.
the ini file (configPath) is a file in that directory.

Parameters:

rootDir - - required name of a project root directory to seek in the main class JAR file.

configPath - -- required name of a configuration file to seek in the project root directory.

Returns:

CaseInsensitiveFile pointing to the newly extracted configuration file, or null.

See Also:

MainClass