Config file meta information. More...

Public Member Functions
	ConfigFile (String host)
	ConfigFile (String host, String filenames)
	Construct from host name and a colon separated list of file names.
DocChapter	owner ()
	Accessor for attribute owner.
DocChapter	owner (DocChapter owner)
	Mutator for attribute owner.
String	ownerHeading ()
	Accessor for attribute ownerHeading.
String	ownerHeading (String ownerHeading)
	Mutator for attribute ownerHeading.
Vector	revisedAlternatives ()
	Get a Vector of possible file paths for this configuration file.
String	citeFile (int versions)
Vector	fileHistory ()
	Find all the file versions available in the configuration file store.
String	host ()
	Accessor for attribute host.
String	host (String host)
	Mutator for attribute host.
File	fileRoot ()
	Return the root directory of config files store for the current host.
Vector	pathAlternatives ()
	Accessor for attribute pathAlternatives.
void	addAlternative (String path)
	Add alternative to the list of possible file paths (.
void	addAlternative (String[] path)
	Add alternatives to the list of possible file paths (.
void	addAlternative (Vector path)
	Add alternatives to the list of possible file paths (.
void	addAlternativeSpec (String path)
	Add alternative to the list of possible file paths (.
void	rotate ()
	someone is attempting to replace this config file, so rename it.

Static Public Member Functions
static Vector	getFiles (String host, String filenames)
	given a host name and a (colon separated) list of filename, return a vector of config files at this location.

Protected Attributes
DocChapter	owner = null
	Chapter with a description of whoever owns this config file.
String	ownerHeading = null
	Short text of the file's owner.
Vector	revisedAlternatives = null
String	host = null
	The name of the host this config file is located on.
File	fileRoot = null
Vector	pathAlternatives = new Vector()
	possible paths this file might be found under

Static Protected Attributes
static final int	keepVersions = 20
static final long	keepFor = 365243600*1000

Detailed Description

Config file meta information.

Constructor & Destructor Documentation

sfi.director.application.autodoc.ConfigFile.ConfigFile ( String host )

References sfi.director.application.autodoc.ConfigFile.host().

Referenced by sfi.director.application.autodoc.ConfigFile.getFiles().

sfi.director.application.autodoc.ConfigFile.ConfigFile	(	String	host,
		String	filenames
	)

Construct from host name and a colon separated list of file names.

References sfi.director.application.autodoc.ConfigFile.addAlternativeSpec(), and sfi.director.application.autodoc.ConfigFile.host().

Member Function Documentation

void sfi.director.application.autodoc.ConfigFile.addAlternative ( String path )

Add alternative to the list of possible file paths (.

See Also: pathAlternatives())

References sfi.director.application.autodoc.ConfigFile.pathAlternatives(), and sfi.director.application.autodoc.ConfigFile.revisedAlternatives().

Referenced by sfi.director.application.autodoc.ConfigFile.addAlternative().

void sfi.director.application.autodoc.ConfigFile.addAlternative ( String[] path )

Add alternatives to the list of possible file paths (.

See Also: pathAlternatives())

References sfi.director.application.autodoc.ConfigFile.addAlternative().

void sfi.director.application.autodoc.ConfigFile.addAlternative ( Vector path )

Add alternatives to the list of possible file paths (.

See Also: pathAlternatives())

References sfi.director.application.autodoc.ConfigFile.revisedAlternatives().

void sfi.director.application.autodoc.ConfigFile.addAlternativeSpec ( String path )

Add alternative to the list of possible file paths (.

See Also: pathAlternatives()). Multiple locations may be encoded in the argument, separated by colons.

References sfi.director.application.autodoc.ConfigFile.pathAlternatives(), sfi.director.application.autodoc.ConfigFile.revisedAlternatives(), and sfi.director.util.Tools.split().

Referenced by sfi.director.application.autodoc.ConfigFile.ConfigFile().

String sfi.director.application.autodoc.ConfigFile.citeFile ( int versions )

References sfi.director.util.Tools.execUtility(), sfi.director.application.autodoc.ConfigFile.fileHistory(), sfi.director.util.Tools.log(), sfi.director.application.autodoc.DocChapter.verbatim(), and sfi.director.util.Logger.WARNING.

Referenced by sfi.director.application.autodoc.DocBuilder.configfilesdoc().

Vector sfi.director.application.autodoc.ConfigFile.fileHistory ( )

Find all the file versions available in the configuration file store.

Returns: a Vector of java.io.File objects, sorted by age (most recent first)

References sfi.director.application.autodoc.ConfigFile.fileRoot(), sfi.director.application.autodoc.ConfigFile.revisedAlternatives(), and sfi.director.util.Tools.sort().

Referenced by sfi.director.application.autodoc.ConfigFile.citeFile(), and sfi.director.application.autodoc.ConfigFile.rotate().

File sfi.director.application.autodoc.ConfigFile.fileRoot ( )

Return the root directory of config files store for the current host.

References sfi.director.util.MyProperties.getProperty(), sfi.director.application.autodoc.ConfigFile.host(), and sfi.director.util.Setup.properties.

Referenced by sfi.director.application.autodoc.ConfigFile.fileHistory(), and sfi.director.application.autodoc.ConfigFile.revisedAlternatives().

static Vector sfi.director.application.autodoc.ConfigFile.getFiles	(	String	host,
		String	filenames
	)

static

given a host name and a (colon separated) list of filename, return a vector of config files at this location.

If the config file specified is a file (the usual case), then exactly one ConfigFile is returned, if it is a directory, for each file within the directory a ConfigFile is created.

References sfi.director.application.autodoc.ConfigFile.ConfigFile(), sfi.director.application.autodoc.ConfigFile.fileRoot, sfi.director.system.FileStats.isDirectory(), sfi.director.system.Files.lstat(), and sfi.director.application.autodoc.ConfigFile.revisedAlternatives.

Referenced by sfi.director.application.autodoc.DocBuilder.domaindoc(), and sfi.director.application.autodoc.DocBuilder.hostdoc().

String sfi.director.application.autodoc.ConfigFile.host ( )

Accessor for attribute host.

The name of the host this config file is located on.

Referenced by sfi.director.application.autodoc.ConfigFile.ConfigFile(), sfi.director.application.autodoc.ConfigFile.fileRoot(), and sfi.director.application.autodoc.ConfigFile.host().

String sfi.director.application.autodoc.ConfigFile.host ( String host )

Mutator for attribute host.

The name of the host this config file is located on.

References sfi.director.application.autodoc.ConfigFile.host().

DocChapter sfi.director.application.autodoc.ConfigFile.owner ( )

Accessor for attribute owner.

Chapter with a description of whoever owns this config file.

Referenced by sfi.director.application.autodoc.ConfigFile.owner().

DocChapter sfi.director.application.autodoc.ConfigFile.owner ( DocChapter owner )

Mutator for attribute owner.

Chapter with a description of whoever owns this config file.

References sfi.director.application.autodoc.ConfigFile.owner().

String sfi.director.application.autodoc.ConfigFile.ownerHeading ( )

Accessor for attribute ownerHeading.

Short text of the file's owner.

Referenced by sfi.director.application.autodoc.ConfigFile.ownerHeading().

String sfi.director.application.autodoc.ConfigFile.ownerHeading ( String ownerHeading )

Mutator for attribute ownerHeading.

Short text of the file's owner.

References sfi.director.application.autodoc.ConfigFile.ownerHeading().

Vector sfi.director.application.autodoc.ConfigFile.pathAlternatives ( )

Accessor for attribute pathAlternatives.

possible paths this file might be found under

Referenced by sfi.director.application.autodoc.ConfigFile.addAlternative(), sfi.director.application.autodoc.ConfigFile.addAlternativeSpec(), and sfi.director.application.autodoc.ConfigFile.revisedAlternatives().

Vector sfi.director.application.autodoc.ConfigFile.revisedAlternatives ( )

Get a Vector of possible file paths for this configuration file.

This may but need not be the same list as pathAlternatives(): if one or more of the alternatives is found in the local configuration file store, then this file(s) will be listed in the returned Vector while the other paths are dropped. If none of the alternatives is found in the configuration file store, then the whole list of alternatives is being returned.

References sfi.director.application.autodoc.ConfigFile.fileRoot(), and sfi.director.application.autodoc.ConfigFile.pathAlternatives().

Referenced by sfi.director.application.autodoc.ConfigFile.addAlternative(), sfi.director.application.autodoc.ConfigFile.addAlternativeSpec(), and sfi.director.application.autodoc.ConfigFile.fileHistory().

void sfi.director.application.autodoc.ConfigFile.rotate ( )

someone is attempting to replace this config file, so rename it.

References sfi.director.application.autodoc.ConfigFile.fileHistory(), sfi.director.application.autodoc.ConfigFile.keepFor, and sfi.director.application.autodoc.ConfigFile.keepVersions.

Referenced by sfi.director.application.autodoc.InfoCollector.push().