com.xmlmind.xmleditapp.base

Class ScanFiles

java.lang.Object

com.xmlmind.xmleditapp.base.ScanFiles

All Implemented Interfaces:

AppSpecKeys

public class ScanFiles
extends Object
implements AppSpecKeys

Not part of the public API: utility scanning the installation directory and the user preferences directory in order to populate a map specifying how to assemble and configure the application.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ScanFiles.CompareURLByBaseName
protected static class	ScanFiles.Listing

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	addonBaseName
protected static String	addonPathProperty
protected static String	addonPathPropertyRef
protected static ScanFiles.CompareURLByBaseName	compareURLByBaseName
protected ArrayList<URL>	configurationList
protected static String	configurationSuffix
protected static String	dictionarySuffix
protected ArrayList<String>	documentFormatPluginClassNameList
protected static String	documentFormatPluginService
protected static String	documentFormatPluginSuffix
protected ArrayList<String>	drivePluginClassNameList
protected static String	drivePluginService
protected static String	drivePluginSuffix
protected ArrayList<String>	errorList
protected ArrayList<String>	foProcessorPluginClassNameList
protected static String	foProcessorPluginService
protected static String	foProcessorPluginSuffix
protected static String	guiCustomizationBaseName
protected ArrayList<URL>	guiCustomizationList
protected ArrayList<String>	imageToolkitPluginClassNameList
protected static String	imageToolkitPluginService
protected static String	imageToolkitPluginSuffix
protected ArrayList<URL>	jarList
protected ArrayList<String>	spellCheckerPluginClassNameList
protected static String	spellCheckerPluginService
protected static String	spellCheckerPluginSuffix
protected static String	userPreferencesDirProperty
protected static String	userPreferencesDirPropertyRef
protected ArrayList<URL>	xmlCatalogList
protected static String	xmlCatalogSuffix

Fields inherited from interface com.xmlmind.xmleditapp.base.AppSpecKeys

commandLineArgumentsKey, configurationURLsKey, documentFormatPluginClassNamesKey, drivePluginClassNamesKey, foProcessorPluginClassNamesKey, guiCustomizationURLsKey, guiSpecLocationKey, imageToolkitPluginClassNamesKey, installDirectoryKey, jarURLsKey, preferencePropertiesKey, spellCheckerPluginClassNamesKey, startErrorsKey, systemPropertiesKey, userPreferencesDirectoryKey, xmlCatalogURLsKey

Constructor Summary

Constructors

Constructor and Description
ScanFiles() Constructs a ScanFiles utility.

Method Summary

Modifier and Type	Method and Description
protected Object[]	addonDirs(File installDir, File userDir)
protected static Properties	configureProxies(File userDir)
protected URL	createURL(URL baseURL, String path)
protected void	doScanAddonDir(File addonDir, boolean testOsArch, ArrayList<URL> confList)
protected static String	getNonEmptyProperty(String propName)
protected File	installDir()
static boolean	isMarkedAsRemoved(File dir)
static boolean	markAsRemoved(File dir, String specFileName)
protected static boolean	removeMarked(File dir)
static boolean	retryRename(File from, File to)
protected void	scanAddonDir(File addonDir, boolean testOsArch)
protected void	scanAddonDirs(File installDir, File userDir, boolean testOsArch)
protected void	scanAddonListing(String[] paths, URL baseURL, boolean testOsArch)
void	scanFiles(File installDir, File userDir, boolean testOsArch, Map<String,Object> appSpecs) Scans the installation directory and, optionally, the user preferences directory in order to populate a map specifying how to assemble and configure the application.
void	scanFiles(Map<String,Object> appSpecs) Scans the installation directory and the user preferences directory in order to populate a map specifying how to assemble and configure the application.
protected String	serviceImpl(URL jarURL, String serviceName)
protected boolean	skipAddonDir(File addonDir, File[] files)
static File	userPreferencesDir() Returns the user preferences directory.

Methods inherited from class java.lang.Object

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

Field Detail

addonBaseName

protected static final String addonBaseName

See Also:

Constant Field Values

addonPathProperty

protected static final String addonPathProperty

See Also:

Constant Field Values

addonPathPropertyRef

protected static final String addonPathPropertyRef

See Also:

Constant Field Values

userPreferencesDirProperty

protected static final String userPreferencesDirProperty

See Also:

Constant Field Values

userPreferencesDirPropertyRef

protected static final String userPreferencesDirPropertyRef

See Also:

Constant Field Values

drivePluginSuffix

protected static final String drivePluginSuffix

See Also:

Constant Field Values

foProcessorPluginSuffix

protected static final String foProcessorPluginSuffix

See Also:

Constant Field Values

imageToolkitPluginSuffix

protected static final String imageToolkitPluginSuffix

See Also:

Constant Field Values

spellCheckerPluginSuffix

protected static final String spellCheckerPluginSuffix

See Also:

Constant Field Values

documentFormatPluginSuffix

protected static final String documentFormatPluginSuffix

See Also:

Constant Field Values

configurationSuffix

protected static final String configurationSuffix

See Also:

Constant Field Values

xmlCatalogSuffix

protected static final String xmlCatalogSuffix

See Also:

Constant Field Values

dictionarySuffix

protected static final String dictionarySuffix

See Also:

Constant Field Values

guiCustomizationBaseName

protected static final String guiCustomizationBaseName

See Also:

Constant Field Values

drivePluginService

protected static final String drivePluginService

See Also:

Constant Field Values

foProcessorPluginService

protected static final String foProcessorPluginService

See Also:

Constant Field Values

imageToolkitPluginService

protected static final String imageToolkitPluginService

See Also:

Constant Field Values

spellCheckerPluginService

protected static final String spellCheckerPluginService

See Also:

Constant Field Values

documentFormatPluginService

protected static final String documentFormatPluginService

See Also:

Constant Field Values

compareURLByBaseName

protected static final ScanFiles.CompareURLByBaseName compareURLByBaseName

jarList

protected ArrayList<URL> jarList

drivePluginClassNameList

protected ArrayList<String> drivePluginClassNameList

foProcessorPluginClassNameList

protected ArrayList<String> foProcessorPluginClassNameList

imageToolkitPluginClassNameList

protected ArrayList<String> imageToolkitPluginClassNameList

spellCheckerPluginClassNameList

protected ArrayList<String> spellCheckerPluginClassNameList

documentFormatPluginClassNameList

protected ArrayList<String> documentFormatPluginClassNameList

configurationList

protected ArrayList<URL> configurationList

xmlCatalogList

protected ArrayList<URL> xmlCatalogList

guiCustomizationList

protected ArrayList<URL> guiCustomizationList

errorList

protected ArrayList<String> errorList

Constructor Detail

ScanFiles

public ScanFiles()

Constructs a ScanFiles utility. Such utility is intended to be used just once.

See Also:

scanFiles(java.util.Map<java.lang.String, java.lang.Object>)

Method Detail

scanFiles

public void scanFiles(Map<String,Object> appSpecs)
               throws RuntimeException

Scans the installation directory and the user preferences directory in order to populate a map specifying how to assemble and configure the application.

Parameters:

appSpecs - map populated by this method

Throws:

RuntimeException

installDir

protected File installDir()
                   throws RuntimeException

Throws:

RuntimeException

scanFiles

public void scanFiles(File installDir,
                      File userDir,
                      boolean testOsArch,
                      Map<String,Object> appSpecs)

Scans the installation directory and, optionally, the user preferences directory in order to populate a map specifying how to assemble and configure the application.

Parameters:

installDir - the installation directory

userDir - the user preferences directory. May be null.

testOsArch - if true, JAR files containing native libraries not compatible with the current operating system/architecture are ignored

appSpecs - map populated by this method

See Also:

OsArchUtil

userPreferencesDir

public static final File userPreferencesDir()

Returns the user preferences directory. May return null or a non-existent path.

configureProxies

protected static final Properties configureProxies(File userDir)

scanAddonDirs

protected void scanAddonDirs(File installDir,
                             File userDir,
                             boolean testOsArch)

addonDirs

protected Object[] addonDirs(File installDir,
                             File userDir)

getNonEmptyProperty

protected static final String getNonEmptyProperty(String propName)

scanAddonListing

protected void scanAddonListing(String[] paths,
                                URL baseURL,
                                boolean testOsArch)

createURL

protected URL createURL(URL baseURL,
                        String path)

serviceImpl

protected String serviceImpl(URL jarURL,
                             String serviceName)

scanAddonDir

protected void scanAddonDir(File addonDir,
                            boolean testOsArch)

skipAddonDir

protected boolean skipAddonDir(File addonDir,
                               File[] files)

doScanAddonDir

protected void doScanAddonDir(File addonDir,
                              boolean testOsArch,
                              ArrayList<URL> confList)

removeMarked

protected static final boolean removeMarked(File dir)

isMarkedAsRemoved

public static final boolean isMarkedAsRemoved(File dir)

markAsRemoved

public static boolean markAsRemoved(File dir,
                                    String specFileName)

retryRename

public static boolean retryRename(File from,
                                  File to)