|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jets3t.service.utils.FileComparer
public class FileComparer
File comparison utility to compare files on the local computer with objects present in a service account and determine whether there are any differences. This utility contains methods to build maps of the contents of the local file system or service account for comparison, and buildDiscrepancyLists methods to find differences in these maps.
File comparisons are based primarily on MD5 hashes of the files' contents. If a local file does not match an object in the service with the same name, this utility determine which of the items is newer by comparing the last modified dates.
Nested Class Summary | |
---|---|
class |
FileComparer.PartialObjectListing
|
Constructor Summary | |
---|---|
FileComparer(Jets3tProperties jets3tProperties)
Constructs the class. |
Method Summary | |
---|---|
FileComparerResults |
buildDiscrepancyLists(java.util.Map<java.lang.String,java.io.File> filesMap,
java.util.Map<java.lang.String,StorageObject> objectsMap)
Compares the contents of a directory on the local file system with the contents of a service resource. |
FileComparerResults |
buildDiscrepancyLists(java.util.Map<java.lang.String,java.io.File> filesMap,
java.util.Map<java.lang.String,StorageObject> objectsMap,
BytesProgressWatcher progressWatcher)
Compares the contents of a directory on the local file system with the contents of a service resource. |
java.util.Map<java.lang.String,java.io.File> |
buildFileMap(java.io.File[] files,
boolean includeDirectories)
Builds a File Map containing the given files. |
java.util.Map<java.lang.String,java.io.File> |
buildFileMap(java.io.File rootDirectory,
java.lang.String fileKeyPrefix,
boolean includeDirectories)
Builds a File Map containing all the files and directories inside the given root directory, where the map's key for each file is the relative path to the file. |
protected void |
buildFileMapImpl(java.io.File directory,
java.lang.String fileKeyPrefix,
java.util.Map<java.lang.String,java.io.File> fileMap,
boolean includeDirectories,
java.util.List<java.util.regex.Pattern> parentIgnorePatternList)
Recursively builds a File Map containing all the files and directories inside the given directory, where the map's key for each file is the relative path to the file. |
protected java.util.List<java.util.regex.Pattern> |
buildIgnoreRegexpList(java.io.File directory,
java.util.List<java.util.regex.Pattern> parentIgnorePatternList)
If a .jets3t-ignore file is present in the given directory, the file is read
and all the paths contained in it are coverted to regular expression Pattern objects. |
java.util.Map<java.lang.String,StorageObject> |
buildObjectMap(StorageService service,
java.lang.String bucketName,
java.lang.String targetPath,
boolean skipMetadata,
StorageServiceEventListener eventListener)
Builds an service Object Map containing all the objects within the given target path, where the map's key for each object is the relative path to the object. |
java.util.Map<java.lang.String,StorageObject> |
buildObjectMap(StorageService service,
java.lang.String bucketName,
java.lang.String targetPath,
StorageObject[] objectsIncomplete,
boolean skipMetadata,
StorageServiceEventListener eventListener)
Builds a service Object Map containing all the given objects, by retrieving HEAD details about all the objects and using populateObjectMap(String, StorageObject[])
to product an object/key map. |
FileComparer.PartialObjectListing |
buildObjectMapPartial(StorageService service,
java.lang.String bucketName,
java.lang.String targetPath,
java.lang.String priorLastKey,
boolean completeListing,
boolean skipMetadata,
StorageServiceEventListener eventListener)
Builds a service Object Map containing a partial set of objects within the given target path, where the map's key for each object is the relative path to the object. |
static FileComparer |
getInstance()
|
static FileComparer |
getInstance(Jets3tProperties jets3tProperties)
|
protected boolean |
isIgnored(java.util.List<java.util.regex.Pattern> ignorePatternList,
java.io.File file)
Determines whether a file should be ignored when building a file map. |
StorageObject[] |
listObjectsThreaded(StorageService service,
java.lang.String bucketName,
java.lang.String targetPath)
Lists the objects in a bucket using a partitioning technique to divide the object namespace into separate partitions that can be listed by multiple simultaneous threads. |
StorageObject[] |
listObjectsThreaded(StorageService service,
java.lang.String bucketName,
java.lang.String targetPath,
java.lang.String delimiter,
int toDepth)
Lists the objects in a bucket using a partitioning technique to divide the object namespace into separate partitions that can be listed by multiple simultaneous threads. |
protected java.lang.String |
normalizeUnicode(java.lang.String str)
Normalize string into "Normalization Form Canonical Decomposition" (NFD). |
java.util.Map<java.lang.String,StorageObject> |
populateObjectMap(java.lang.String targetPath,
StorageObject[] objects)
Builds a map of key/object pairs each object is associated with a key based on its location in the service target path. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FileComparer(Jets3tProperties jets3tProperties)
jets3tProperties
- the object containing the properties that will be applied in this class.Method Detail |
---|
public static FileComparer getInstance(Jets3tProperties jets3tProperties)
jets3tProperties
- the object containing the properties that will be applied in the instance.
public static FileComparer getInstance()
protected java.util.List<java.util.regex.Pattern> buildIgnoreRegexpList(java.io.File directory, java.util.List<java.util.regex.Pattern> parentIgnorePatternList)
.jets3t-ignore
file is present in the given directory, the file is read
and all the paths contained in it are coverted to regular expression Pattern objects.
If the parent directory's list of patterns is provided, any relevant patterns are also
added to the ignore listing. Relevant parent patterns are those with a directory prefix
that matches the current directory, or with the wildcard depth pattern (*.*./).
directory
- a directory that may contain a .jets3t-ignore
file. If this parameter is null
or is actually a file and not a directory, an empty list will be returned.parentIgnorePatternList
- a list of Patterns that were applied to the parent directory of the given directory. If this
parameter is null, no parent ignore patterns are applied.
protected boolean isIgnored(java.util.List<java.util.regex.Pattern> ignorePatternList, java.io.File file)
ignorePatternList
- a list of Pattern objects representing the file names to ignore.file
- a file that will either be ignored or not, depending on whether it matches an ignore Pattern
or is a symlink/alias.
protected java.lang.String normalizeUnicode(java.lang.String str)
str
-
public java.util.Map<java.lang.String,java.io.File> buildFileMap(java.io.File[] files, boolean includeDirectories)
File keys are delimited with '/' characters.
Any file or directory matching a path in a .jets3t-ignore
file will be ignored.
files
- the set of files/directories to include in the file map.includeDirectories
- If true all directories, including empty ones, will be included in the Map. These directories
will be mere place-holder objects with a trailing slash (/) character in the name and the
content type Mimetypes.MIMETYPE_BINARY_OCTET_STREAM
.
If this variable is false directory objects will not be included in the Map, and it will not
be possible to store empty directories in the service.
public java.util.Map<java.lang.String,java.io.File> buildFileMap(java.io.File rootDirectory, java.lang.String fileKeyPrefix, boolean includeDirectories)
File keys are delimited with '/' characters.
Any file or directory matching a path in a .jets3t-ignore
file will be ignored.
rootDirectory
- The root directory containing the files/directories of interest. The root directory is not
included in the result map.fileKeyPrefix
- A prefix added to each file path key in the map, e.g. the name of the root directory the
files belong to. If provided, a '/' suffix is always added to the end of the prefix. If null
or empty, no prefix is used.includeDirectories
- If true all directories, including empty ones, will be included in the Map. These directories
will be mere place-holder objects with a trailing slash (/) character in the name and the
content type Mimetypes.MIMETYPE_BINARY_OCTET_STREAM
.
If this variable is false directory objects will not be included in the Map, and it will not
be possible to store empty directories in the service.
buildDiscrepancyLists(Map, Map)
,
buildObjectMap(StorageService, String, String, boolean, StorageServiceEventListener)
protected void buildFileMapImpl(java.io.File directory, java.lang.String fileKeyPrefix, java.util.Map<java.lang.String,java.io.File> fileMap, boolean includeDirectories, java.util.List<java.util.regex.Pattern> parentIgnorePatternList)
File keys are delimited with '/' characters.
Any file or directory matching a path in a .jets3t-ignore
file will be ignored.
directory
- The directory containing the files/directories of interest. The directory is not
included in the result map.fileKeyPrefix
- A prefix added to each file path key in the map, e.g. the name of the root directory the
files belong to. This prefix must end with a '/' character.fileMap
- a map of path keys to File objects, that this method adds items to.includeDirectories
- If true all directories, including empty ones, will be included in the Map. These directories
will be mere place-holder objects with a trailing slash (/) character in the name and the
content type Mimetypes.MIMETYPE_BINARY_OCTET_STREAM
.
If this variable is false directory objects will not be included in the Map, and it will not
be possible to store empty directories in the service.parentIgnorePatternList
- a list of Patterns that were applied to the parent directory of the given directory. This list
will be checked to see if any of the parent's patterns should apply to the current directory.
See buildIgnoreRegexpList(File, List)
for more information.
If this parameter is null, no parent ignore patterns are applied.public StorageObject[] listObjectsThreaded(StorageService service, java.lang.String bucketName, java.lang.String targetPath, java.lang.String delimiter, int toDepth) throws ServiceException
This partitioning technique will work best for buckets with many objects that are divided into a number of virtual subdirectories of roughly equal size.
service
- the service object that will be used to perform listing requests.bucketName
- the name of the bucket whose contents will be listed.targetPath
- a root path within the bucket to be listed. If this parameter is null, all
the bucket's objects will be listed. Otherwise, only the objects below the
virtual path specified will be listed.delimiter
- the delimiter string used to identify virtual subdirectory partitions
in a bucket. If this parameter is null, or it has a value that is not
present in your object names, no partitioning will take place.toDepth
- the number of delimiter levels this method will traverse to identify
subdirectory partions. If this value is zero, no partitioning will take
place.
ServiceException
public StorageObject[] listObjectsThreaded(StorageService service, java.lang.String bucketName, java.lang.String targetPath) throws ServiceException
This partitioning technique will work best for buckets with many objects that are divided into a number of virtual subdirectories of roughly equal size.
The delimiter and depth properties that define how this method will
partition the bucket's namespace are set in the jets3t.properties file
with the setting:
filecomparer.bucket-listing.<bucketname>=<delim>,<depth>
For example: filecomparer.bucket-listing.my-bucket=/,2
service
- the service object that will be used to perform listing requests.bucketName
- the name of the bucket whose contents will be listed.targetPath
- a root path within the bucket to be listed. If this parameter is null, all
the bucket's objects will be listed. Otherwise, only the objects below the
virtual path specified will be listed.
ServiceException
public java.util.Map<java.lang.String,StorageObject> buildObjectMap(StorageService service, java.lang.String bucketName, java.lang.String targetPath, boolean skipMetadata, StorageServiceEventListener eventListener) throws ServiceException
service
- bucketName
- targetPath
- skipMetadata
- eventListener
-
ServiceException
buildDiscrepancyLists(Map, Map)
,
buildFileMap(File, String, boolean)
public FileComparer.PartialObjectListing buildObjectMapPartial(StorageService service, java.lang.String bucketName, java.lang.String targetPath, java.lang.String priorLastKey, boolean completeListing, boolean skipMetadata, StorageServiceEventListener eventListener) throws ServiceException
If the method is asked to perform a complete listing, it will use the
listObjectsThreaded(StorageService, String, String)
method to list the objects
in the bucket, potentially taking advantage of any bucket name partitioning
settings you have applied.
If the method is asked to perform only a partial listing, no bucket name partitioning will be applied.
service
- bucketName
- targetPath
- priorLastKey
- the prior last key value returned by a prior invocation of this method, if any.completeListing
- if true, this method will perform a complete listing of a service target.
If false, the method will list a partial set of objects commencing from the
given prior last key.
ServiceException
buildDiscrepancyLists(Map, Map)
,
buildFileMap(File, String, boolean)
public java.util.Map<java.lang.String,StorageObject> buildObjectMap(StorageService service, java.lang.String bucketName, java.lang.String targetPath, StorageObject[] objectsIncomplete, boolean skipMetadata, StorageServiceEventListener eventListener) throws ServiceException
populateObjectMap(String, StorageObject[])
to product an object/key map.
service
- bucketName
- targetPath
- skipMetadata
- objectsIncomplete
-
ServiceException
buildDiscrepancyLists(Map, Map)
,
buildFileMap(File[], boolean)
public java.util.Map<java.lang.String,StorageObject> populateObjectMap(java.lang.String targetPath, StorageObject[] objects)
targetPath
- objects
-
public FileComparerResults buildDiscrepancyLists(java.util.Map<java.lang.String,java.io.File> filesMap, java.util.Map<java.lang.String,StorageObject> objectsMap) throws java.security.NoSuchAlgorithmException, java.io.FileNotFoundException, java.io.IOException, java.text.ParseException
filesMap
- a map of keys/Files built using the method buildFileMap(File, String, boolean)
objectsMap
- a map of keys to StorageObjects built using the method
buildObjectMap(StorageService, String, String, boolean, StorageServiceEventListener)
java.security.NoSuchAlgorithmException
java.io.FileNotFoundException
java.io.IOException
java.text.ParseException
public FileComparerResults buildDiscrepancyLists(java.util.Map<java.lang.String,java.io.File> filesMap, java.util.Map<java.lang.String,StorageObject> objectsMap, BytesProgressWatcher progressWatcher) throws java.security.NoSuchAlgorithmException, java.io.FileNotFoundException, java.io.IOException, java.text.ParseException
filesMap
- a map of keys/Files built using the method buildFileMap(File, String, boolean)
objectsMap
- a map of keys to StorageObjects built using the method
buildObjectMap(StorageService, String, String, boolean, StorageServiceEventListener)
progressWatcher
- watches the progress of file hash generation.
java.security.NoSuchAlgorithmException
java.io.FileNotFoundException
java.io.IOException
java.text.ParseException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |