- Revision
- 1308
- Author
- mauro
- Date
- 2009-10-10 17:17:25 -0500 (Sat, 10 Oct 2009)
Log Message
Renamed file manager upload method. Added javadocs.
Modified Paths
- trunk/web/web-io/src/main/java/org/jbehave/web/io/ArchivingFileManager.java
- trunk/web/web-io/src/main/java/org/jbehave/web/io/FileArchiver.java
- trunk/web/web-io/src/main/java/org/jbehave/web/io/FileManager.java
- trunk/web/web-io/src/main/java/org/jbehave/web/io/ResourceFinder.java
- trunk/web/web-io/src/main/java/org/jbehave/web/io/ZipFileArchiver.java
- trunk/web/web-io/src/test/java/org/jbehave/web/io/ArchivingFileManagerTest.java
- trunk/web/web-runner/src/main/java/org/jbehave/web/runner/waffle/controllers/FileUploadController.java
- trunk/web/web-runner/src/test/java/org/jbehave/web/runner/waffle/controllers/FileUploadControllerTest.java
Diff
Modified: trunk/web/web-io/src/main/java/org/jbehave/web/io/ArchivingFileManager.java (1307 => 1308)
--- trunk/web/web-io/src/main/java/org/jbehave/web/io/ArchivingFileManager.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-io/src/main/java/org/jbehave/web/io/ArchivingFileManager.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -11,6 +11,9 @@ import org.apache.commons.fileupload.FileItem; import org.jbehave.web.io.ZipFileArchiver.FileUnarchiveFailedException; +/** + * File manager that uploads and unarchives data files + */ public class ArchivingFileManager implements FileManager { private final FileArchiver archiver; @@ -58,7 +61,7 @@ file.delete(); } - public List<File> write(List<FileItem> fileItems, List<String> errors) { + public List<File> upload(List<FileItem> fileItems, List<String> errors) { List<File> files = new ArrayList<File>(); File directory = uploadDirectory(); for (FileItem item : fileItems) {
Modified: trunk/web/web-io/src/main/java/org/jbehave/web/io/FileArchiver.java (1307 => 1308)
--- trunk/web/web-io/src/main/java/org/jbehave/web/io/FileArchiver.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-io/src/main/java/org/jbehave/web/io/FileArchiver.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -3,6 +3,9 @@ import java.io.File; import java.util.List; +/** + * Allows to unarchive a file and list its content. + */ public interface FileArchiver { boolean isArchive(File file);
Modified: trunk/web/web-io/src/main/java/org/jbehave/web/io/FileManager.java (1307 => 1308)
--- trunk/web/web-io/src/main/java/org/jbehave/web/io/FileManager.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-io/src/main/java/org/jbehave/web/io/FileManager.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -8,6 +8,9 @@ import org.apache.commons.fileupload.FileItem; +/** + * Allow to list, delete and upload data files. + */ public interface FileManager { List<File> list(); @@ -16,6 +19,6 @@ void delete(List<String> paths); - List<File> write(List<FileItem> fileItems, List<String> errors); + List<File> upload(List<FileItem> fileItems, List<String> errors); } \ No newline at end of file
Modified: trunk/web/web-io/src/main/java/org/jbehave/web/io/ResourceFinder.java (1307 => 1308)
--- trunk/web/web-io/src/main/java/org/jbehave/web/io/ResourceFinder.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-io/src/main/java/org/jbehave/web/io/ResourceFinder.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -7,6 +7,15 @@ import org.apache.commons.io.FileUtils; import org.apache.commons.io.IOUtils; +/** + * A utility class to retrieve resource, either from classpath or from + * filesystem, and convert them to strings. Classpath resources are identified + * by a configurable classpath prefix, which defaults to "classpath:". The + * finder will resolve the resource path (i.e. stripping the prefix) and first + * try to find the resource in the injected classloader, which default the + * current thread context classloader, and failing that will fall back on + * looking for the resource in the filesystem. + */ public class ResourceFinder { public static final String DEFAULT_CLASSPATH_PREFIX = "classpath:";
Modified: trunk/web/web-io/src/main/java/org/jbehave/web/io/ZipFileArchiver.java (1307 => 1308)
--- trunk/web/web-io/src/main/java/org/jbehave/web/io/ZipFileArchiver.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-io/src/main/java/org/jbehave/web/io/ZipFileArchiver.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -19,6 +19,9 @@ import org.apache.commons.compress.archivers.zip.ZipFile; import org.apache.commons.io.IOUtils; +/** + * File archiver for zip files + */ public class ZipFileArchiver implements FileArchiver { private static final String ZIP = "zip";
Modified: trunk/web/web-io/src/test/java/org/jbehave/web/io/ArchivingFileManagerTest.java (1307 => 1308)
--- trunk/web/web-io/src/test/java/org/jbehave/web/io/ArchivingFileManagerTest.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-io/src/test/java/org/jbehave/web/io/ArchivingFileManagerTest.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -85,7 +85,7 @@ // ensure files do not exists file2.delete(); dir1.delete(); - manager.write(asList(file2FileItem, zipFileItem), errors); + manager.upload(asList(file2FileItem, zipFileItem), errors); assertEquals(0, errors.size()); } @@ -109,7 +109,7 @@ dir1.delete(); // remove zip zip.delete(); - manager.write(asList(file2FileItem, zipFileItem), errors); + manager.upload(asList(file2FileItem, zipFileItem), errors); assertEquals(2, errors.size()); } @@ -126,7 +126,7 @@ will(returnValue("")); } }); - manager.write(asList(file2FileItem, zipFileItem), errors); + manager.upload(asList(file2FileItem, zipFileItem), errors); assertEquals(0, errors.size()); } @@ -150,7 +150,7 @@ // ensure files do not exists file2.delete(); zip.delete(); - manager.write(asList(file2FileItem, zipFileItem), errors); + manager.upload(asList(file2FileItem, zipFileItem), errors); assertEquals(4, errors.size()); }
Modified: trunk/web/web-runner/src/main/java/org/jbehave/web/runner/waffle/controllers/FileUploadController.java (1307 => 1308)
--- trunk/web/web-runner/src/main/java/org/jbehave/web/runner/waffle/controllers/FileUploadController.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-runner/src/main/java/org/jbehave/web/runner/waffle/controllers/FileUploadController.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -35,7 +35,7 @@ uploadedFiles.clear(); List<FileItem> files = uploader.getFiles(); errors.addAll(uploader.getErrors()); - uploadedFiles.addAll(manager.write(files, errors)); + uploadedFiles.addAll(manager.upload(files, errors)); } public Collection<String> getErrors() {
Modified: trunk/web/web-runner/src/test/java/org/jbehave/web/runner/waffle/controllers/FileUploadControllerTest.java (1307 => 1308)
--- trunk/web/web-runner/src/test/java/org/jbehave/web/runner/waffle/controllers/FileUploadControllerTest.java 2009-10-10 22:01:19 UTC (rev 1307) +++ trunk/web/web-runner/src/test/java/org/jbehave/web/runner/waffle/controllers/FileUploadControllerTest.java 2009-10-10 22:17:25 UTC (rev 1308) @@ -38,7 +38,7 @@ will(returnValue(fileItems)); one(uploader).getErrors(); will(returnValue(errors)); - one(manager).write(with(equal(fileItems)), with(equal(errors))); + one(manager).upload(with(equal(fileItems)), with(equal(errors))); will(returnValue(files)); } });
To unsubscribe from this list please visit:
