org.apache.felix.fileinstall.internal

Class Scanner

java.lang.Object

org.apache.felix.fileinstall.internal.Scanner

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

WatcherScanner

public class Scanner
extends java.lang.Object
implements java.io.Closeable

A Scanner object is able to detect and report new, modified and deleted files. The scanner use an internal checksum to identify the signature of a file or directory. The checksum will change if the file or any of the directory's child is modified. In addition, if the scanner detects a change on a given file, it will wait until the checksum does not change anymore before reporting the change on this file. This allows to not report the change until a big copy if complete for example.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUBDIR_MODE_JAR
static java.lang.String	SUBDIR_MODE_RECURSE
static java.lang.String	SUBDIR_MODE_SKIP

Constructor Summary

Constructors

Constructor and Description
Scanner(java.io.File directory) Create a scanner for the specified directory
Scanner(java.io.File directory, java.lang.String filterString, java.lang.String subdirMode) Create a scanner for the specified directory and file filter

Method Summary

Modifier and Type	Method and Description
void	close()
long	getChecksum(java.io.File file) Retrieve the previously computed checksum for a give file.
void	initialize(java.util.Map<java.io.File,java.lang.Long> checksums) Initialize the list of known files.
java.util.Set<java.io.File>	scan(boolean reportImmediately) Report a set of new, modified or deleted files.
void	updateChecksum(java.io.File file) Update the checksum of a file if that file is already known locally.

Methods inherited from class java.lang.Object

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

Field Detail

SUBDIR_MODE_JAR

public static final java.lang.String SUBDIR_MODE_JAR

See Also:

Constant Field Values

SUBDIR_MODE_SKIP

public static final java.lang.String SUBDIR_MODE_SKIP

See Also:

Constant Field Values

SUBDIR_MODE_RECURSE

public static final java.lang.String SUBDIR_MODE_RECURSE

See Also:

Constant Field Values

Constructor Detail

Scanner

public Scanner(java.io.File directory)

Create a scanner for the specified directory

Parameters:

directory - the directory to scan

Scanner

public Scanner(java.io.File directory,
               java.lang.String filterString,
               java.lang.String subdirMode)

Create a scanner for the specified directory and file filter

Parameters:

directory - the directory to scan

filterString - a filter for file names

subdirMode - to use when scanning

Method Detail

initialize

public void initialize(java.util.Map<java.io.File,java.lang.Long> checksums)

Initialize the list of known files. This should be called before the first scan to initialize the list of known files. The purpose is to be able to detect files that have been deleted while the scanner was inactive.

Parameters:

checksums - a map of checksums

scan

public java.util.Set<java.io.File> scan(boolean reportImmediately)

Report a set of new, modified or deleted files. Modifications are checked against a computed checksum on some file attributes to detect any modification. Upon restart, such checksums are not known so that all files will be reported as modified.

Parameters:

reportImmediately - report all files immediately without waiting for the checksum to be stable

Returns:

a list of changes on the files included in the directory

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getChecksum

public long getChecksum(java.io.File file)

Retrieve the previously computed checksum for a give file.

Parameters:

file - the file to retrieve the checksum

Returns:

the checksum

updateChecksum

public void updateChecksum(java.io.File file)

Update the checksum of a file if that file is already known locally.