blob: ab8bc95ce3b975878b62b69be842645ef2e48ceb (
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
|
/*
* 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.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import com.vaadin.Application;
import com.vaadin.service.FileTypeResolver;
import com.vaadin.terminal.Terminal.ErrorEvent;
/**
* <code>FileResources</code> are files or directories on local filesystem. The
* files and directories are served through URI:s to the client terminal and
* thus must be registered to an URI context before they can be used. The
* resource is automatically registered to the application when it is created.
*
* @author Vaadin Ltd.
* @since 3.0
*/
@SuppressWarnings("serial")
public class FileResource implements ApplicationResource {
/**
* Default buffer size for this stream resource.
*/
private int bufferSize = 0;
/**
* File where the downloaded content is fetched from.
*/
private File sourceFile;
/**
* Application.
*/
private final Application application;
/**
* Default cache time for this stream resource.
*/
private long cacheTime = DownloadStream.DEFAULT_CACHETIME;
/**
* Creates a new file resource for providing given file for client
* terminals.
*/
public FileResource(File sourceFile, Application application) {
this.application = application;
setSourceFile(sourceFile);
application.addResource(this);
}
/**
* Gets the resource as stream.
*
* @see com.vaadin.terminal.ApplicationResource#getStream()
*/
@Override
public DownloadStream getStream() {
try {
final DownloadStream ds = new DownloadStream(new FileInputStream(
sourceFile), getMIMEType(), getFilename());
ds.setParameter("Content-Length",
String.valueOf(sourceFile.length()));
ds.setCacheTime(cacheTime);
return ds;
} catch (final FileNotFoundException e) {
// Log the exception using the application error handler
getApplication().getErrorHandler().terminalError(new ErrorEvent() {
@Override
public Throwable getThrowable() {
return e;
}
});
return null;
}
}
/**
* Gets the source file.
*
* @return the source File.
*/
public File getSourceFile() {
return sourceFile;
}
/**
* Sets the source file.
*
* @param sourceFile
* the source file to set.
*/
public void setSourceFile(File sourceFile) {
this.sourceFile = sourceFile;
}
/**
* @see com.vaadin.terminal.ApplicationResource#getApplication()
*/
@Override
public Application getApplication() {
return application;
}
/**
* @see com.vaadin.terminal.ApplicationResource#getFilename()
*/
@Override
public String getFilename() {
return sourceFile.getName();
}
/**
* @see com.vaadin.terminal.Resource#getMIMEType()
*/
@Override
public String getMIMEType() {
return FileTypeResolver.getMIMEType(sourceFile);
}
/**
* Gets the length of cache expiration time. 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. Default is
* <code>DownloadStream.DEFAULT_CACHETIME</code>.
*
* @return Cache time in milliseconds.
*/
@Override
public long getCacheTime() {
return cacheTime;
}
/**
* Sets the length of cache expiration time. 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.
*
* @param cacheTime
* the cache time in milliseconds.
*/
public void setCacheTime(long cacheTime) {
this.cacheTime = cacheTime;
}
/* 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;
}
}
|
