blob: bbb58c71e2a5d898a12d9399880a8367e4e22e67 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*
* Copyright 2011 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.terminal;
import java.io.InputStream;
import java.io.Serializable;
import com.vaadin.Application;
import com.vaadin.service.FileTypeResolver;
/**
* <code>StreamResource</code> is a resource provided to the client directly by
* the application. The strean resource is fetched from URI that is most often
* in the context of the application or window. The resource is automatically
* registered to window in creation.
*
* @author Vaadin Ltd.
* @since 3.0
*/
@SuppressWarnings("serial")
public class StreamResource implements ApplicationResource {
/**
* Source stream the downloaded content is fetched from.
*/
private StreamSource streamSource = null;
/**
* Explicit mime-type.
*/
private String MIMEType = null;
/**
* Filename.
*/
private String filename;
/**
* Application.
*/
private final Application application;
/**
* Default buffer size for this stream resource.
*/
private int bufferSize = 0;
/**
* Default cache time for this stream resource.
*/
private long cacheTime = DEFAULT_CACHETIME;
/**
* Creates a new stream resource for downloading from stream.
*
* @param streamSource
* the source Stream.
* @param filename
* the name of the file.
* @param application
* the Application object.
*/
public StreamResource(StreamSource streamSource, String filename,
Application application) {
this.application = application;
setFilename(filename);
setStreamSource(streamSource);
// Register to application
application.addResource(this);
}
/**
* @see com.vaadin.terminal.Resource#getMIMEType()
*/
@Override
public String getMIMEType() {
if (MIMEType != null) {
return MIMEType;
}
return FileTypeResolver.getMIMEType(filename);
}
/**
* Sets the mime type of the resource.
*
* @param MIMEType
* the MIME type to be set.
*/
public void setMIMEType(String MIMEType) {
this.MIMEType = MIMEType;
}
/**
* Returns the source for this <code>StreamResource</code>. StreamSource is
* queried when the resource is about to be streamed to the client.
*
* @return Source of the StreamResource.
*/
public StreamSource getStreamSource() {
return streamSource;
}
/**
* Sets the source for this <code>StreamResource</code>.
* <code>StreamSource</code> is queried when the resource is about to be
* streamed to the client.
*
* @param streamSource
* the source to set.
*/
public void setStreamSource(StreamSource streamSource) {
this.streamSource = streamSource;
}
/**
* Gets the filename.
*
* @return the filename.
*/
@Override
public String getFilename() {
return filename;
}
/**
* Sets the filename.
*
* @param filename
* the filename to set.
*/
public void setFilename(String filename) {
this.filename = filename;
}
/**
* @see com.vaadin.terminal.ApplicationResource#getApplication()
*/
@Override
public Application getApplication() {
return application;
}
/**
* @see com.vaadin.terminal.ApplicationResource#getStream()
*/
@Override
public DownloadStream getStream() {
final StreamSource ss = getStreamSource();
if (ss == null) {
return null;
}
final DownloadStream ds = new DownloadStream(ss.getStream(),
getMIMEType(), getFilename());
ds.setBufferSize(getBufferSize());
ds.setCacheTime(cacheTime);
return ds;
}
/**
* Interface implemented by the source of a StreamResource.
*
* @author Vaadin Ltd.
* @since 3.0
*/
public interface StreamSource extends Serializable {
/**
* Returns new input stream that is used for reading the resource.
*/
public InputStream getStream();
}
/* documented in superclass */
@Override
public int getBufferSize() {
return bufferSize;
}
/**
* Sets the size of the download buffer used for this resource.
*
* @param bufferSize
* the size of the buffer in bytes.
*/
public void setBufferSize(int bufferSize) {
this.bufferSize = bufferSize;
}
/* documented in superclass */
@Override
public long getCacheTime() {
return cacheTime;
}
/**
* Sets the length of cache expiration time.
*
* <p>
* This gives the adapter the possibility cache streams sent to the client.
* The caching may be made in adapter or at the client if the client
* supports caching. Zero or negavive value disbales the caching of this
* stream.
* </p>
*
* @param cacheTime
* the cache time in milliseconds.
*
*/
public void setCacheTime(long cacheTime) {
this.cacheTime = cacheTime;
}
}
|
