Aurigma ActiveX/Java Uploader 8.5.55
POST Field Reference
This topic contains information about POST fields (both standard and custom) which are sent by ActiveX/Java Uploader. Use it when writing the server-side upload processing code. You should extract them in the same manner as if they were sent through the standard HTML form. See Saving Uploaded Files in ActiveX/Java Uploader ASP.NET and Saving Uploaded Files in ActiveX/Java Uploader PHP topics for more details on how to work with them.
The table below contains a list of POST fields that are generated and uploaded by ActiveX/Java Uploader, if they are enabled by the metadata.enableAllStandardFields(Boolean) or metadata.enableStandardField(String, Boolean) methods.
Zero-based index of the package inside the current upload session.
Using this field you can recognize the order of the uploaded files if they were sent in different packages.
A total number of packages in the current upload session.
In particular, when FilesPerPackage is 1, it can be used to get a total number of files uploaded within this upload session.
Unique identifier of the current upload session.
When the upload is separated into several packages, all of them will have the same GUID. You can use it to determine whether files are uploaded in the same session (useful for concurrent uploads from several users) or not.
|PackageFileCount||Integer||Number of files uploaded in the current package.|
Request integrity flag.
This field is sent at the end of the upload request. Thus, if this field is not received the upload is considered as cancelled.
|PackageComplete||Integer||End of package marker. This field is always 1 and is represented only in the last request of a package.|
|RequestCount||Integer||Number of requests associated with a package. This field is sent in the end of the package.|
|UploaderID||String||Unique client identifier of an uploader. You can use it to determine what uploader sent the package (or chunk).|
|Original File Information|
Name of the original Nth file. If entire folder is uploaded, this field includes a folder structure, i.e. relative path of the file (relatively the folder which is being uploaded, including this folder name).
It is useful to employ this field to get the name of the original file when only a resized copy of an image is uploaded.
|SourceSize_N *||Integer||Size of the original Nth file in bytes.|
Creation date of the original Nth file in EXIF-style format:
The last modification date of the original Nth file in EXIF-style format:
The local creation date of the original Nth file in EXIF-style format:
The local last modification date of the original Nth file in EXIF-style format:
|SourceWidth_N *||Integer||Width of the original Nth file in pixels if it is an image. Otherwise, this field contains 0.|
|SourceHeight_N *||Integer||Height of the original Nth file in pixels if it is an image. Otherwise, this field contains 0.|
|HorizontalResolution_N *||Integer||Horizontal resolution of the original Nth file if it is an image (measured in DPI - dots per inches). Otherwise, this field contains 0.|
|VerticalResolution_N *||Integer||Vertical resolution of the original Nth file if it is an image (measured in DPI - dots per inches). Otherwise, this field contains 0.|
|Converted File Information|
|The fields from this group are sent if at least one Converter is specified.|
The Xth converted file for the Nth user-selected file.
Depending on the FileXMode_N field value, this field contains a file with one of the following names:
The mode of the Xth converted file created for the Nth user-selected file. Possible values are:
|FileXSize_N **||Integer||Size of the Xth converted file created for the Nth user-selected file (in bytes).|
Actual width of the Xth converted file created for the Nth user-selected file if it is an image (in pixels). Otherwise, this field contains 0.
Depending on the Converter.ThumbnailFitMode, this value may differ from the value specified through the Converter.ThumbnailWidth property. This happens because ActiveX/Java Uploader preserves the aspect ratio of the image and seldom can use the same dimensions as specified in thumbnail parameters.
Actual height of the Xth converted file created for the Nth user-selected file if it is an image (in pixels). Otherwise, this field contains 0.
Depending on the ThumbnailFitMode, this value may differ from the value specified through the Converter.ThumbnailHeight property. This happens because ActiveX/Java Uploader preserves the aspect ratio of the image and seldom can use the same dimensions as specified in thumbnail parameters.
Zero-based index of this chunk of the Xth converted file created for the Nth user-selected file.
Number of chunks of the Xth converted file created for the Nth user-selected file.
Rotation angle of the Nth user-specified file (measured in degrees clockwise).
You can use it if you want to rotate images on the server side (e.g. if you upload original files only). Possible values are:
|Description_N *||String||User-provided description of the Nth user-selected file.|
|Tag_N *||String||Tag attached to the Nth user-selected file.|
Crop bounds of the Nth user-selected image in the following format: x,y,width,height. For non-image files this field contains 0,0,0,0 value.
You can use it if you want to crop images on the server side (e.g. if you upload only original file).
* The N character appended to the field name is a placeholder for an index of this file in the uploaded package. This index is zero-based. For example, ActiveX/Java Uploader sends one file per package, so to retrieve a name of this file use the SourceName_0 field (the same is true for other XXX_N fields).
** ActiveX/Java Uploader can generate unlimited number of converted files per each user-selected file and send them to the server. The X character is a placeholder for an index of the converted file created for the Nth user-selected file. Maximum X value is not bigger than the number of Converter instances added to the Uploader.Converters array. For example, if you set two converters, the following fields will be available on the server: File0_0 and File1_0.
ActiveX/Java Uploader is able to send not only fields described in the table above, but also custom fields. It can be done in two ways:
- Using the Metadata.AdditionalFormName property. You just add the <form> element somewhere to your code, add elements to it (<input>, <select>, <textarea> elements are supported), and set its name as a value of this property. Then ActiveX/Java Uploader automatically appends data from this <form> to the request that is sent to the server.
- Using the metadata.addCustomField(String, String, Boolean) method. It takes the name of a field you want to receive on the server and its value. The most convenient place to use this method is the BeforeUpload event. Any custom fields added via this method can be removed by calling the metadata.removeCustomField(String) method.
ActiveX/Java Uploader can also extract and generate additional information for user-selected files and send it in POST request. In particular, you can extract EXIF and IPTC metadata from images just by specifying desired fields in the Metadata.Exif and Metadata.Iptc properties.
If it is necessary to organize robust upload and check the integrity of uploaded files, you can use the Metadata.Hash property. It specifies a hash algorithm used to generate a hash sum for each user-selected file. Thus, to verify whether a file is uploaded successfully, you need to calculate its hash sum using the same algorithm and compares it with the uploaded one.
See the Uploading Additional Data in ActiveX/Java Uploader ASP.NET and Uploading Additional Data in ActiveX/Java Uploader PHP topics for details.