votorola.a.trust

Class ReadyDirectory

java.lang.Object

java.io.File

OutputStore.ReadyDirectory

ReadyDirectory

All Implemented Interfaces:

Serializable, Comparable<File>

@ThreadSafe
public final class ReadyDirectory
extends OutputStore.ReadyDirectory

The path to a snap/readyTrace record. It is the file part of the backing for a traced trust network and a compiled registration list. It is guaranteed to be in canonical form at the time of construction.

See Also:

snap/readyTrace record, NetworkTrace, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static FileFilter	READY_DIRECTORY_FILTER A file filter that accepts only apparent ready directories.

Fields inherited from class OutputStore.ReadyDirectory

STATUS_FLAG_MOUNTED, STATUS_FLAG_REPORTED, STATUS_FLAGS_COUNT

Fields inherited from class java.io.File

pathSeparator, pathSeparatorChar, separator, separatorChar

Constructor Summary

Constructors

Constructor and Description
ReadyDirectory(File d) Constructs a ReadyDirectory from an abstract (File) pathname.
ReadyDirectory(String pathname) Constructs a ReadyDirectory from a string pathname.

Method Summary

Methods

Modifier and Type	Method and Description
static ReadyDirectory	createReadyDirectory(File snapDirectory) Creates a ready directory and returns an instance of it.
(package private) File	inRegistrationFile() The file storing the snapshot of registrant input from the streetwiki, in XML format.
boolean	isMounted() Answers whether the trace is nominally mounted.
NetworkTrace	mount(Trustserver trustserver, boolean isVerbose) Traces the trust network, compiles the registration list, and posts the results to the database and filebase.
File	mountedDirectory() The directory to which the trace is serialized, when mounted.
File	newListSerialFile(String area) Constructs the file to which a registration list is serialized when mounted.
File	newTraceSerialFile() Constructs the file to which a network trace is serialized when mounted.
boolean	unmount(VoteServer.Run vsRun) Reverses a previous mount, erasing the results from the database and filebase.

Methods inherited from class OutputStore.ReadyDirectory

snapDirectory, statusPrintln, statusPrintln, toUIString, toUIString

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, length, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toPath, toString, toURI, toURL

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

READY_DIRECTORY_FILTER

public static final FileFilter READY_DIRECTORY_FILTER

A file filter that accepts only apparent ready directories.

Constructor Detail

ReadyDirectory

public ReadyDirectory(File d)
               throws IOException

Constructs a ReadyDirectory from an abstract (File) pathname.

Parameters:

d - the abstract pathname. It will be converted to canonical form if necessary.

Throws:

FileNotFoundException - if no directory exists at the specified pathname.

IOException

See Also:

createReadyDirectory(File)

ReadyDirectory

public ReadyDirectory(String pathname)
               throws IOException

Constructs a ReadyDirectory from a string pathname.

Parameters:

pathname - the string pathname, per File(pathname). It will be converted to canonical form if necessary.

Throws:

FileNotFoundException - if no directory exists at the specified pathname.

IOException

See Also:

createReadyDirectory(File)

Method Detail

createReadyDirectory

public static ReadyDirectory createReadyDirectory(File snapDirectory)
                                           throws IOException

Creates a ready directory and returns an instance of it.

Parameters:

snapDirectory - the parent directory in which to create the new ready directory.

Throws:

IOException

inRegistrationFile

File inRegistrationFile()

The file storing the snapshot of registrant input from the streetwiki, in XML format.

mount

public NetworkTrace mount(Trustserver trustserver,
                 boolean isVerbose)
                   throws AddressException,
                          IOException,
                          ScriptException,
                          SQLException,
                          XMLStreamException

Traces the trust network, compiles the registration list, and posts the results to the database and filebase.

Throws:

AddressException

IOException

ScriptException

SQLException

XMLStreamException

See Also:

isMounted(), unmount(VoteServer.Run)

mountedDirectory

public File mountedDirectory()

The directory to which the trace is serialized, when mounted.

newListSerialFile

public File newListSerialFile(String area)

Constructs the file to which a registration list is serialized when mounted. Each area has a separate list, and the list of unlocalized registrations is serialized to the file '_mountedTrace/_default.xml'.

newTraceSerialFile

public File newTraceSerialFile()

Constructs the file to which a network trace is serialized when mounted.

unmount

public boolean unmount(VoteServer.Run vsRun)
                throws IOException,
                       SQLException

Reverses a previous mount, erasing the results from the database and filebase.

Returns:

true if the trace was unmounted, false if it was not mounted to begin with, either in whole or part.

Throws:

IOException

SQLException

See Also:

isMounted(), mount(Trustserver,boolean)

isMounted

public boolean isMounted()

Answers whether the trace is nominally mounted.

Specified by:

isMounted in class OutputStore.ReadyDirectory