Documentation: dependency on commons-io and other things

• Key: FILEUPLOAD-114
• Type: Wish
• Status: Closed
• Resolution: Fixed
• Priority: Minor
• Assignee: Henri Yandell
• Reporter: Olle Sundblad
• Affects Version/s: 1.1.1

Description

Somewhere in the documentation (User guide and/or FAQ) I think there should be at least one sentence specifying that FileUpload requires the Apache commons-io package.

From someone who spent a good 4h of frustration to learn that.

Also in the User guide:

// Check that we have a file upload request
boolean isMultipart = ServletFileUpload.isMultipartContent(request);

isMultipartContent is Deprecated and I couldn't find a replacement for it in 1.1.1. And in the following:

// Create a factory for disk-based file items
FileItemFactory factory = new DiskFileItemFactory();

// Create a new file upload handler
ServletFileUpload upload = new ServletFileUpload(factory);

// Parse the request
List /* FileItem */ items = upload.parseRequest(request);

the factory is not working in this state you need to

factory.setRepository(someDir);

or use the other constructor.

otherwise thanks for an other great product (now that I can use it)
/Olle
PS Why are you not using generics?

Comments

[Henri Yandell]

There are places on the site that mention the commons-io bit - but putting the dependency at the top of the user guide sounds like a very good idea.

The reason for not using generics is to support pre 5.0 users; there are still a lot around. About the only thing you can really be sure about nowadays is that 1.1 can be ignored.

Thanks for the report; will work on getting them fixed.

[Henri Yandell]

Olle, do you have the error message you were getting when IO was not present? If so, then I could also make a FAQ entry.

[Henri Yandell]

On the need for a directory to be set - looks like the intention was for the code to use java.io.tmpdir as a default, but the code doesn't match that. So need to find out if the code or the docs should change.

[Jochen Wiedmann]

> Also in the User guide:
>
> // Check that we have a file upload request
> boolean isMultipart = ServletFileUpload.isMultipartContent(request);
>
> isMultipartContent is Deprecated and I couldn't find a replacement for it in 1.1.1.

I have changed the docs in that sense.

[Amichai Rothman]

Running under Tomcat 5.5 I got the error:

java.lang.NoClassDefFoundError: org/apache/commons/io/output/DeferredFileOutputStream

this may be a bit implementation dependent... I guess any NoClassDefFoundError for org/apache/commons/io classes would mean the same thing - perhaps this can be explained in the FAQ/userguide just in case.

[Henri Yandell]

FAQ entry added.

Just need to deploy the site now so this issue can be resolved.

[Henri Yandell]

Site should be deployed in 2 hours.

[Henri Yandell]

Site deployed.