Skip to Content

Wiki source code of WOFileUpload

Version 41.1 by Johan Henselmans on 2023/11/13 11:57
Hide last authors
Pascal Robert 37.1 1 {{toc/}}
Kieran Kelleher 8.1 2
3 = Introduction =
4
Pascal Robert 40.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:documentation.Home.Development Architecture.Dynamic Elements.WOForm.WebHome]]) 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 |(((
Pascal Robert 39.1 57
Pascal Robert 39.2 58
Pascal Robert 40.1 59
Johan Henselmans 41.1 60
Pascal Robert 37.1 61 data
62 )))|(((
63 NSData
64 )))|(((
65 out
66 )))|(((
67 No
68 )))|(((
69 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.
70 )))
71 |(((
72 inputStream
73 )))|(((
74 String
75 )))|(((
76 in
77 )))|(((
78 No
79 )))|(((
80 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.
81 )))
82 |(((
83 bufferSize
84 )))|(((
85 int
86 )))|(((
87 in
88 )))|(((
89 No
90 )))|(((
91 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.
92 )))
93 |(((
94 outputStream
95 )))|(((
96 String
97 )))|(((
98 out
99 )))|(((
100 No
101 )))|(((
102 WebObjects copies the file upload data from the content to the outputStream specified by this attribute.
103 )))
104 |(((
105 streamToFilePath
106 )))|(((
107 String
108 )))|(((
109 in
110 )))|(((
111 No
112 )))|(((
113 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.
114 )))
115 |(((
116 overwrite
117 )))|(((
118 boolean
119 )))|(((
120 in
121 )))|(((
122 No
123 )))|(((
124 When streamToFilePath is specified, this binding determines whether WebObjects should overwrite an existing file. Defaults to false.
125 )))
126 |(((
127 finalFilePath
128 )))|(((
129 String
130 )))|(((
131 out
132 )))|(((
133 No
134 )))|(((
135 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).
136 )))
137
Pascal Robert 31.1 138 = Examples =
139
140 == Java methods ==
141
Pascal Robert 37.1 142 {{code/}}
Kieran Kelleher 8.1 143
Pascal Robert 31.1 144 == WOD-style ==
Kieran Kelleher 8.1 145
Pascal Robert 37.1 146 {{code/}}
Kieran Kelleher 8.1 147
Pascal Robert 31.1 148 == Inline bindings (WOOGNL) ==
149
150 {{code}}
151
152 <wo:form enctype = "multipart/form-data">
Kieran Kelleher 35.1 153
154 <wo:fileUpload streamToFilePath="$streamPathLocation"
155 overwrite="true"
156 filePath="$clientFilePath"
157 finalFilePath="$finalFilePath" />
158
Pascal Robert 31.1 159 </wo:form>
160
161 {{/code}}
Kieran Kelleher 33.1 162
163 = Related documents =
164
Pascal Robert 37.1 165 [[ERXWOFileUpload>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/extensions/components/_private/ERXWOFileUpload.html||shape="rect"]]
166 [[AjaxFileUpload>>url:http://wocommunity.org/documents/javadoc/wonder/latest/er/ajax/AjaxFileUpload.html||shape="rect"]]
167 [[NSPathUtilities.lastPathComponent>>url:http://wocommunity.org/documents/javadoc/WebObjects/5.4.2/com/webobjects/foundation/NSPathUtilities.html#lastPathComponent(java.lang.String)||shape="rect"]]
Pascal Robert 39.2 168 [[ERAttachment>>doc:documentation.ERAttachment Framework]]
Pascal Robert 39.1 169 [[Database vs Filesystem>>doc:documentation.Home.Best Practices.Development-Database vs Filesystem.WebHome]]
Johan Henselmans 41.1 170 [[Localization and Internationalization>>doc:documentation.Home.Development Architecture.Localization.Development-Localization and Internationalization.WebHome]]