org.zimowski.bambi.editor.plugins

Class MultipartFormPostImageUploader

java.lang.Object

javax.swing.SwingWorker<Void,Void>

org.zimowski.bambi.editor.plugins.api.AbstractPlugin

org.zimowski.bambi.editor.plugins.api.AbstractImagePlugin

org.zimowski.bambi.editor.plugins.api.AbstractImageExporter

org.zimowski.bambi.editor.plugins.MultipartFormPostImageUploader

All Implemented Interfaces:

Runnable, Future<Void>, RunnableFuture<Void>, ImageExporter, ImagePlugin, Plugin

public class MultipartFormPostImageUploader
extends AbstractImageExporter

Sends data using MultipartFormPost off an EDT thread keeping the GUI responsive. Capable of processing server response according to a custom protocol. Does not perform any GUI drawing, but delegates these tasks via ExportStateMonitor and ExportProgressMonitor.

The spec for this protocol server response is multi-line plain text in KEY|VALUE format where KEY is the message identifier which Bambi knows about and VALUE is the actual message.

The following KEYS are supported:

• STATUS - one of the following: OK,ERROR - required
• RECEIVED - bytes received (number) - required
• PROCESSED - bytes processed by the server (number) - required
• DATE - timestamp when submission was processed - optional
• MSG - info message if STATUS=OK, error message if STATUS=ERROR - optional

Example response 1 (success):

 STATUS|OK
 RECEIVED|42933
 PROCESSED|42933
 DATE|2013-01-10 13:27:30
 

Example response 2 (error):

 STATUS|ERROR
 RECEIVED|2342
 PROCESSED|0
 DATE|2013-01-02 09:07:11
 MSG|Incomplete Payload. Expected 292342 bytes.
 

Author:

Adam Zimowski (mrazjava)

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_PROP_SCRIPT Name of the server side script that will receive and process the uploaded image.
static org.slf4j.Logger	log

Fields inherited from class org.zimowski.bambi.editor.plugins.api.AbstractImageExporter

CONFIG_TOOTLIP, exportDef, parent

Fields inherited from class org.zimowski.bambi.editor.plugins.api.AbstractImagePlugin

selectorId

Fields inherited from class org.zimowski.bambi.editor.plugins.api.AbstractPlugin

configuration

Constructor Summary

Constructors

Constructor and Description
MultipartFormPostImageUploader()

Method Summary

Methods

Modifier and Type	Method and Description
protected Void	doInBackground()

Methods inherited from class org.zimowski.bambi.editor.plugins.api.AbstractImageExporter

done, export, getTooltip

Methods inherited from class org.zimowski.bambi.editor.plugins.api.AbstractImagePlugin

setSelectorId

Methods inherited from class org.zimowski.bambi.editor.plugins.api.AbstractPlugin

initialize

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.zimowski.bambi.editor.plugins.api.ImagePlugin

setSelectorId

Methods inherited from interface org.zimowski.bambi.editor.plugins.api.Plugin

initialize

Field Detail

log

public static final org.slf4j.Logger log

CONFIG_PROP_SCRIPT

public static final String CONFIG_PROP_SCRIPT

Name of the server side script that will receive and process the uploaded image. For example, if using PHP this could be something like processUpload.php which could perform authentication and load the image to a database. Requires picture prefix identifier to assemble full parameter name.

See Also:

Constant Field Values

Constructor Detail

MultipartFormPostImageUploader

public MultipartFormPostImageUploader()

Method Detail

doInBackground

protected Void doInBackground()
                       throws Exception

Specified by:

doInBackground in class SwingWorker<Void,Void>

Throws:

Exception