diff options
author | Artur Signell <artur@vaadin.com> | 2012-08-29 11:30:17 +0300 |
---|---|---|
committer | Artur Signell <artur@vaadin.com> | 2012-08-29 11:30:17 +0300 |
commit | e18177bac62e8367829dfc5ec3083a09973e621e (patch) | |
tree | 4deea17d44a770f6d300f1f905f6d03c79a54b46 /server/src/com/vaadin/terminal/StreamResource.java | |
parent | bfbfdd51a0563d212d1e811a3eb534122847d206 (diff) | |
download | vaadin-framework-e18177bac62e8367829dfc5ec3083a09973e621e.tar.gz vaadin-framework-e18177bac62e8367829dfc5ec3083a09973e621e.zip |
Renamed com.vaadin.terminal -> com.vaadin.server (#9431)
Diffstat (limited to 'server/src/com/vaadin/terminal/StreamResource.java')
-rw-r--r-- | server/src/com/vaadin/terminal/StreamResource.java | 230 |
1 files changed, 0 insertions, 230 deletions
diff --git a/server/src/com/vaadin/terminal/StreamResource.java b/server/src/com/vaadin/terminal/StreamResource.java deleted file mode 100644 index bbb58c71e2..0000000000 --- a/server/src/com/vaadin/terminal/StreamResource.java +++ /dev/null @@ -1,230 +0,0 @@ -/* - * 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; - } - -} |