Skip to Content

Wiki source code of WOFileUpload

Version 38.1 by Pascal Robert on 2012/01/30 22:18
Hide last authors
Pascal Robert 37.1 1 {{toc/}}
Kieran Kelleher 8.1 2
3 = Introduction =
4
Pascal Robert 37.1 5 The **WOFileUpload** element allows you to add an <input type=file> HTML element into your form, hence letting your users upload files to your server. This element must be inside an HTML form ([[doc:WOForm]]) element and the //enctype// binding of the form must be set to "multipart/form-data" (see the examples).
Kieran Kelleher 8.1 6
Pascal Robert 36.1 7 Starting with WebObjects 5.2, it is possible to stream file uploads so that the entire file is not stored in memory on the server while being uploaded.
Kieran Kelleher 8.1 8
Pascal Robert 31.1 9 = Usage =
Kieran Kelleher 8.1 10
11 {{code}}
12
Kieran Kelleher 35.1 13 WOFileUpload {
14 filePath=aPath;
15 data=fileData;
16 [inputStream=fileName];
17 [bufferSize=sizeKB];
18 [outputStream=fileName];
19 [streamToFilePath=filePath];
20 [overwrite=[boolean]];
Kieran Kelleher 33.1 21 [finalFilePath=filePath];
22 }
Kieran Kelleher 8.1 23
24 {{/code}}
25
Pascal Robert 31.1 26 = Bindings =
Kieran Kelleher 8.1 27
Pascal Robert 37.1 28 |=(((
29 Binding Name
30 )))|=(((
31 Binding Type
32 )))|=(((
33 In/Out
34 )))|=(((
35 Required
36 )))|=(((
37 Description
38 )))
39 |(((
40 filePath
41 )))|(((
42 String
43 )))|(((
44 in
45 )))|(((
46 Yes
47 )))|(((
48 The name of the file being uploaded, including the full path when the client is on Windows. To get only the name of the file without the full path, you can use
Kieran Kelleher 8.1 49
Pascal Robert 37.1 50 {{code}}
51 NSPathUtilities.lastPathComponent(filePath)
52 {{/code}}
53
54
55 )))
56 |(((
57 data
58 )))|(((
59 NSData
60 )))|(((
61 out
62 )))|(((
63 No
64 )))|(((
65 The file being uploaded will be stored in a [[NSData>>url:http://www.webobjects.me/API/wo542/com/webobjects/foundation/NSData.html||shape="rect"]] object. Please note that the entire file will be in-memory, so beware of out-of-memory errors if users upload large files.
66 )))
67 |(((
68 inputStream
69 )))|(((
70 String
71 )))|(((
72 in
73 )))|(((
74 No
75 )))|(((
76 The binding will be set to an InputStream that points to the file upload. Note that the input stream points directly to the multipart request body part incoming stream and thus you **must** consume this input stream and close it inside the current request action logic. If you use this binding, you can only have one WOFileUpload element in your form, and it have to be the last element of the form and the form's multipleSubmit attribute must be set to false. Our advice, just use streamToFilePath.
77 )))
78 |(((
79 bufferSize
80 )))|(((
81 int
82 )))|(((
83 in
84 )))|(((
85 No
86 )))|(((
87 Sets the size (in bytes) of the buffer used by the outputStream and streamToFilePath attributes. The default buffer size is 512KB. There is no reasonable restriction on the buffer size.
88 )))
89 |(((
90 outputStream
91 )))|(((
92 String
93 )))|(((
94 out
95 )))|(((
96 No
97 )))|(((
98 WebObjects copies the file upload data from the content to the outputStream specified by this attribute.
99 )))
100 |(((
101 streamToFilePath
102 )))|(((
103 String
104 )))|(((
105 in
106 )))|(((
107 No
108 )))|(((
109 WebObjects writes the file upload data from the content directly to the file path specified in this attribute. This is an atomic operation~-~--the data is written to a temporary file, which is renamed when the process is complete.
110 )))
111 |(((
112 overwrite
113 )))|(((
114 boolean
115 )))|(((
116 in
117 )))|(((
118 No
119 )))|(((
120 When streamToFilePath is specified, this binding determines whether WebObjects should overwrite an existing file. Defaults to false.
121 )))
122 |(((
123 finalFilePath
124 )))|(((
125 String
126 )))|(((
127 out
128 )))|(((
129 No
130 )))|(((
131 When streamToFilePath is specified, its value is set to the actual file location (it may differ from the streamToFilePath value if there is a problem renaming the file).
132 )))
133
Pascal Robert 31.1 134 = Examples =
135
136 == Java methods ==
137
Pascal Robert 37.1 138 {{code/}}
Kieran Kelleher 8.1 139
Pascal Robert 31.1 140 == WOD-style ==
Kieran Kelleher 8.1 141
Pascal Robert 37.1 142 {{code/}}
Kieran Kelleher 8.1 143
Pascal Robert 31.1 144 == Inline bindings (WOOGNL) ==
145
146 {{code}}
147
148 <wo:form enctype = "multipart/form-data">
Kieran Kelleher 35.1 149
150 <wo:fileUpload streamToFilePath="$streamPathLocation"
151 overwrite="true"
152 filePath="$clientFilePath"
153 finalFilePath="$finalFilePath" />
154
Pascal Robert 31.1 155 </wo:form>
156
157 {{/code}}
Kieran Kelleher 33.1 158
159 = Related documents =
160
Pascal Robert 37.1 161 [[ERXWOFileUpload>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/extensions/components/_private/ERXWOFileUpload.html||shape="rect"]]
162 [[AjaxFileUpload>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/ajax/AjaxFileUpload.html||shape="rect"]]
163 [[NSPathUtilities.lastPathComponent>>url:http://wocommunity.org/documents/javadoc/WebObjects/5.4.2/com/webobjects/foundation/NSPathUtilities.html#lastPathComponent(java.lang.String)||shape="rect"]]
164 [[ERAttachment>>doc:ERAttachment Framework]]
165 [[Database vs Filesystem>>doc:Development-Database vs Filesystem]]
166 [[Localization and Internationalization>>doc:Development-Localization and Internationalization]]