GWT Uploader

An API to enable sophisticated file upload capabilities within a GWT application.

The source code was forked from http://www.moxiegroup.com/moxieapps/gwt-uploader/ and applied a few fixes.

Please see examples with source code here: http://gwt-uploader.appspot.com/

• For GWT 2.7.0, please use gwt-upload 1.1.x
• For GWT 2.8.0+, please use gwt-upload 1.2.x

What is it?

GWT Uploader is a freely available open source GWT library that encapsulates the file upload capabilities provided by the File and XMLHttpRequest Level 2 APIs.

Using GWT Uploader allows for enhanced file upload dialogs (multiple uploads, drag and drop, queues, parallel streams, etc.) and interactive interfaces (upload progress indicators, real-time throughput display, upload cancellation, etc.) within GWT applications using pure Java code that provides a consistent experience across all browsers.

If the browser is capable of handling file uploads using a modern HTML5 approach, the upload is handled using pure DOM elements and Javascript events. In the case that the browser does not support the modern approach an error is shown.

Key Features

• Simple: Adds consistent file upload support to all modern browsers with a single implementation, while still supporting legacy browsers automatically.

• Pure Java: The entire set of file upload capabilities are available via GWT powered Java methods, including clean interfaces for the various runtime callbacks (no need to write any JavaScript).

• Customizable Interfaces: GWT Uploader exposes all the file upload capabilities as a GWT Widget, making it easy to create your own aesthetic for your upload controls or leave it simple and benefit from the multiple file selection and queued uploading. Convenient methods are also provided to enable file uploads via a familiar drag and drop approach.

• Clean Syntax: The API is built using fluent methods that allow you to manage the configuration options of the the upload control using syntax that is nearly as tight as JSON.

• Dynamic: GWT Uploader automatically includes the necessary plugin capabilities to expose various throughput and performance metrics of the uploads during and after an upload. Each File object has the following properties:

  • getAverageSpeed() -- Overall average upload speed, in bytes per second
  • getCurrentSpeed() -- String indicating the upload speed, in bytes per second
  • getMovingAverageSpeed() -- Speed over averaged over the last several measurements, in bytes per second
  • getPercentUploaded() -- Percentage of the file uploaded (0 to 100)
  • getSizeUploaded() -- Formatted size uploaded so far, bytes
  • getTimeElapsed() -- Number of seconds passed for this upload
  • getTimeRemaining() -- Estimated remaining upload time in seconds These metrics allow for dynamic updates to occur in your interface, whether it's progress bars or text labels, as data is transferred for one or more files.

• Documented: Every class and method of the API is thoroughly documented, including numerous code and syntax examples throughout.

• Examples: The demonstration examples provide several basic examples of upload interfaces that demonstrate the flexibility and integration opportunities available, with each example including a convenient "View Source" button that will allow you to see the code behind each implementation.

Configure Maven dependency

GWT Uploader is available in Maven central repository:

http://search.maven.org/#search%7Cga%7C1%7Cgwt-uploader

To add the dependency to your build.gradle (for Gradle projects) or pom.xml (for Maven projects), use the following configuration:

For Gradle projects:

implementation 'org.docstr:gwt-uploader:1.2.5'

For Maven projects:

<dependency>
    <groupId>org.docstr</groupId>
    <artifactId>gwt-uploader</artifactId>
    <version>1.2.5</version>
</dependency>

How to use GWT Uploader?

Please see examples with source code here: http://gwt-uploader.appspot.com/

How to contribute

Use the following command to checkout the source code:

git clone git@github.com:jiakuan/gwt-uploader.git gwt-uploader-root

Here are the steps:

• Create a new issue for things to discuss
• After discussion about changes, fork the project and make changes
• Run gradle clean build to make sure no build errors
• Create a new pull request for review and discussion
• After confirmation, we will merge the pull request to master