systems.dmx.files

Class UploadedFile

java.lang.Object

systems.dmx.files.UploadedFile

public class UploadedFile
extends Object

An uploaded file.

Files are uploaded via the REST API by POSTing multipart/form-data to a resource method which consumes multipart/form-data and has UploadedFile as its entity parameter.

Author:

Jörg Richter

Constructor Summary

Constructors

Constructor and Description
UploadedFile(String name, long size, InputStream in, DiskQuotaCheck diskQuotaCheck)

Method Summary

Modifier and Type	Method and Description
InputStream	getInputStream() Returns an InputStream that can be used to retrieve the contents of the uploaded file.
String	getName() Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
String	getString() Returns the contents of the uploaded file as a String, using the default character encoding.
String	getString(String encoding) Returns the contents of the uploaded file as a String, using the given encoding.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadedFile

public UploadedFile(String name,
                    long size,
                    InputStream in,
                    DiskQuotaCheck diskQuotaCheck)

Method Detail

getName

public String getName()

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.

getString

public String getString()

Returns the contents of the uploaded file as a String, using the default character encoding.

getString

public String getString(String encoding)

Returns the contents of the uploaded file as a String, using the given encoding.

getInputStream

public InputStream getInputStream()

Returns an InputStream that can be used to retrieve the contents of the uploaded file.

toString

public String toString()

Overrides:

toString in class Object