com.sshtools.sftp.DirectoryOperation Maven / Gradle / Ivy
The newest version!
/**
* Copyright 2003-2016 SSHTOOLS Limited. All Rights Reserved.
*
* For product documentation visit https://www.sshtools.com/
*
* This file is part of J2SSH Maverick.
*
* J2SSH Maverick is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* J2SSH Maverick is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with J2SSH Maverick. If not, see
* This class provides a list of operations that have been/or will be completed
* by the SftpClient's copyRemoteDirectory/copyLocalDirectory methods.
*
*
* The objects returned could either be {@link com.sshtools.sftp.SftpFile} or
* java.io.File depending upon the commit state and whether
* syncronization is required. Any code using the values returned should be able
* to handle both types of file object.
*
*
* @author Lee David Painter
*/
@SuppressWarnings({ "rawtypes", "unchecked" })
public class DirectoryOperation {
Vector unchangedFiles = new Vector();
Vector newFiles = new Vector();
Vector updatedFiles = new Vector();
Vector deletedFiles = new Vector();
Vector recursedDirectories = new Vector();
Hashtable failedTransfers = new Hashtable();
/**
* Construct a new directory operation object
*/
public DirectoryOperation() {
}
void addNewFile(File f) {
newFiles.addElement(f);
}
void addFailedTransfer(File f, SftpStatusException ex) {
failedTransfers.put(f, ex);
}
void addUpdatedFile(File f) {
updatedFiles.addElement(f);
}
void addDeletedFile(File f) {
deletedFiles.addElement(f);
}
void addUnchangedFile(File f) {
unchangedFiles.addElement(f);
}
void addNewFile(SftpFile f) {
newFiles.addElement(f);
}
void addFailedTransfer(SftpFile f, SftpStatusException ex) {
failedTransfers.put(f, ex);
}
void addUpdatedFile(SftpFile f) {
updatedFiles.addElement(f);
}
void addDeletedFile(SftpFile f) {
deletedFiles.addElement(f);
}
void addUnchangedFile(SftpFile f) {
unchangedFiles.addElement(f);
}
/**
* Returns a list of new files that will be transfered in the directory
* operation
*
* @return Vector
*/
public Vector getNewFiles() {
return newFiles;
}
/**
* Returns a list of files that will be updated in the directory operation
*
* @return Vector
*/
public Vector getUpdatedFiles() {
return updatedFiles;
}
/**
* Returns the list of files that will not be changed during the directory
* operation
*
* @return Vector
*/
public Vector getUnchangedFiles() {
return unchangedFiles;
}
/**
* When synchronizing directories, this method will return a list of files
* that will be deleted becasue they no longer exist at the source location.
*
* @return Vector
*/
public Vector getDeletedFiles() {
return deletedFiles;
}
/**
* Returns a Hashtable of files and exceptions.
*
* @return Vector
*/
public Hashtable getFailedTransfers() {
return failedTransfers;
}
/**
* Determine whether the operation contains a file.
*
* @param f
* @return boolean
*/
public boolean containsFile(File f) {
return unchangedFiles.contains(f) || newFiles.contains(f)
|| updatedFiles.contains(f) || deletedFiles.contains(f)
|| recursedDirectories.contains(f)
|| failedTransfers.containsKey(f);
}
/**
* Determine whether the directory operation contains an SftpFile
*
* @param f
* @return boolean
*/
public boolean containsFile(SftpFile f) {
return unchangedFiles.contains(f) || newFiles.contains(f)
|| updatedFiles.contains(f) || deletedFiles.contains(f)
|| recursedDirectories.contains(f.getAbsolutePath())
|| failedTransfers.containsKey(f);
}
/**
* Add the contents of another directory operation. This is used to record
* changes when recuring through directories.
*
* @param op
* @param f
*/
public void addDirectoryOperation(DirectoryOperation op, File f) {
addAll(op.getUpdatedFiles(), updatedFiles);
addAll(op.getNewFiles(), newFiles);
addAll(op.getUnchangedFiles(), unchangedFiles);
addAll(op.getDeletedFiles(), deletedFiles);
Object obj;
for (Enumeration e = op.failedTransfers.keys(); e.hasMoreElements();) {
obj = e.nextElement();
failedTransfers.put(obj, op.failedTransfers.get(obj));
}
recursedDirectories.addElement(f);
}
void addAll(Vector source, Vector dest) {
for (Enumeration e = source.elements(); e.hasMoreElements();) {
dest.addElement(e.nextElement());
}
}
/**
* Get the total number of new and changed files to transfer
*
* @return int
*/
public int getFileCount() {
return newFiles.size() + updatedFiles.size();
}
/**
* Add the contents of another directory operation. This is used to record
* changes when recuring through directories.
*
* @param op
* @param file
*/
public void addDirectoryOperation(DirectoryOperation op, String file) {
addAll(op.getUpdatedFiles(), updatedFiles);
addAll(op.getNewFiles(), newFiles);
addAll(op.getUnchangedFiles(), unchangedFiles);
addAll(op.getDeletedFiles(), deletedFiles);
Object obj;
for (Enumeration e = op.failedTransfers.keys(); e.hasMoreElements();) {
obj = e.nextElement();
failedTransfers.put(obj, op.failedTransfers.get(obj));
}
recursedDirectories.addElement(file);
}
/**
* Get the total number of bytes that this operation will transfer
*
* @return long
*/
public long getTransferSize() throws SftpStatusException, SshException {
Object obj;
long size = 0;
SftpFile sftpfile;
File file;
for (Enumeration e = newFiles.elements(); e.hasMoreElements();) {
obj = e.nextElement();
if (obj instanceof File) {
file = (File) obj;
if (file.isFile()) {
size += file.length();
}
} else if (obj instanceof SftpFile) {
sftpfile = (SftpFile) obj;
if (sftpfile.isFile()) {
size += sftpfile.getAttributes().getSize().longValue();
}
}
}
for (Enumeration e = updatedFiles.elements(); e.hasMoreElements();) {
obj = e.nextElement();
if (obj instanceof File) {
file = (File) obj;
if (file.isFile()) {
size += file.length();
}
} else if (obj instanceof SftpFile) {
sftpfile = (SftpFile) obj;
if (sftpfile.isFile()) {
size += sftpfile.getAttributes().getSize().longValue();
}
}
}
// Add a value for deleted files??
return size;
}
}