org.wisepersist.gwt.uploader.client.events

Class UploadSuccessEvent

java.lang.Object

org.wisepersist.gwt.uploader.client.events.UploadEvent

org.wisepersist.gwt.uploader.client.events.UploadSuccessEvent

public class UploadSuccessEvent
extends UploadEvent

Provides access to the raw information provided by Uploader when an 'uploader success' event occurs. This class should not be instantiated directly, but instead you should create a UploadSuccessHandler and register it via the .Uploader#setUploadSuccessHandler(UploadSuccessHandler) method in order to access uploader success events.

Note that 'uploadSuccess' is fired when the entire uploader has been transmitted and the server returns a HTTP 200 status code. Any data outputted by the server is available in the server data property.

Due to some bugs in the Flash Player the server response may not be acknowledged and no uploadSuccess event is fired by Flash. In this case the .client.Uploader#setAssumeSuccessTimeout(long) setting is checked to see if enough time has passed to fire uploadSuccess anyway. In this case the received response parameter will be false.

The Uploader.setHttpSuccess(long...) setting allows uploadSuccess to be fired for HTTP status codes other than 200. In this case no server data is available from the Flash Player.

At this point the uploader is not yet complete. Another uploader cannot be started from uploadSuccess.

Constructor Summary

Constructors

Constructor and Description
UploadSuccessEvent(File file, java.lang.String serverData, java.lang.String responseReceived) This constructor is intended for internal use only.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getResponseReceived() Return the HTTP response code sent from the server at the completion of the uploader.
java.lang.String	getServerData() Return any HTTP response data sent from the server at the completion of the uploader.

Methods inherited from class org.wisepersist.gwt.uploader.client.events.UploadEvent

getFile

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadSuccessEvent

public UploadSuccessEvent(File file,
                          java.lang.String serverData,
                          java.lang.String responseReceived)

This constructor is intended for internal use only. You should not create uploader success events directly, but instead should register a UploadSuccessHandler.

Parameters:

file - The native javascript object containing the details of the file being uploaded.

serverData - Any HTTP response data sent from the server at the completion of the uploader.

responseReceived - The HTTP response code sent from the server at the completion of the uploader.

Method Detail

getServerData

public java.lang.String getServerData()

Return any HTTP response data sent from the server at the completion of the uploader.

Returns:

String

getResponseReceived

public java.lang.String getResponseReceived()

Return the HTTP response code sent from the server at the completion of the uploader.

Returns:

String